com.digitalasset.canton.participant.synchronizer
SynchronizerConnectionConfig
Companion object SynchronizerConnectionConfig
final case class SynchronizerConnectionConfig(synchronizerAlias: SynchronizerAlias, sequencerConnections: SequencerConnections, manualConnect: Boolean = false, synchronizerId: Option[PhysicalSynchronizerId] = None, priority: Int = 0, initialRetryDelay: Option[NonNegativeFiniteDuration] = None, maxRetryDelay: Option[NonNegativeFiniteDuration] = None, timeTracker: SynchronizerTimeTrackerConfig = SynchronizerTimeTrackerConfig(), initializeFromTrustedSynchronizer: Boolean = false) extends HasVersionedWrapper[SynchronizerConnectionConfig] with PrettyPrinting with Product with Serializable
The synchronizer connection configuration object
- synchronizerAlias
alias to be used internally to refer to this synchronizer connection
- sequencerConnections
Configuration for the sequencers. In case of BFT synchronizer - there could be sequencers with multiple connections. Each sequencer can also support high availability, so multiple endpoints could be provided for each individual sequencer.
- manualConnect
if set to true (default false), the synchronizer is not connected automatically on startup.
- synchronizerId
if the synchronizer id is known, then it can be passed as an argument. during the handshake, the participant will check that the synchronizer id on the remote port is indeed the one given in the configuration. the synchronizer id can not be faked by a synchronizer. therefore, this additional check can be used to really ensure that you are talking to the right synchronizer.
- priority
the priority of this synchronizer connection. if there are more than one synchronizer connections, the com.digitalasset.canton.participant.protocol.submission.routing.TransactionRoutingProcessor will pick the synchronizer connection with the highest priority if possible.
- initialRetryDelay
synchronizer connections are "resilient". i.e. if a connection is lost, the system will keep trying to reconnect to a synchronizer.
- maxRetryDelay
control the backoff parameter such that the retry interval does not grow above this value
- timeTracker
the synchronizer time tracker settings. don't change it unless you know what you are doing.
- initializeFromTrustedSynchronizer
if false will automatically generate a SynchronizerTrustCertificate when connecting to a new synchronizer.
- Alphabetic
- By Inheritance
- SynchronizerConnectionConfig
- Serializable
- Product
- Equals
- PrettyPrinting
- PrettyUtil
- ShowUtil
- ShowSyntax
- ToShowOps
- HasVersionedWrapper
- HasVersionedToByteString
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SynchronizerConnectionConfig(synchronizerAlias: SynchronizerAlias, sequencerConnections: SequencerConnections, manualConnect: Boolean = false, synchronizerId: Option[PhysicalSynchronizerId] = None, priority: Int = 0, initialRetryDelay: Option[NonNegativeFiniteDuration] = None, maxRetryDelay: Option[NonNegativeFiniteDuration] = None, timeTracker: SynchronizerTimeTrackerConfig = SynchronizerTimeTrackerConfig(), initializeFromTrustedSynchronizer: Boolean = false)
- synchronizerAlias
alias to be used internally to refer to this synchronizer connection
- sequencerConnections
Configuration for the sequencers. In case of BFT synchronizer - there could be sequencers with multiple connections. Each sequencer can also support high availability, so multiple endpoints could be provided for each individual sequencer.
- manualConnect
if set to true (default false), the synchronizer is not connected automatically on startup.
- synchronizerId
if the synchronizer id is known, then it can be passed as an argument. during the handshake, the participant will check that the synchronizer id on the remote port is indeed the one given in the configuration. the synchronizer id can not be faked by a synchronizer. therefore, this additional check can be used to really ensure that you are talking to the right synchronizer.
- priority
the priority of this synchronizer connection. if there are more than one synchronizer connections, the com.digitalasset.canton.participant.protocol.submission.routing.TransactionRoutingProcessor will pick the synchronizer connection with the highest priority if possible.
- initialRetryDelay
synchronizer connections are "resilient". i.e. if a connection is lost, the system will keep trying to reconnect to a synchronizer.
- maxRetryDelay
control the backoff parameter such that the retry interval does not grow above this value
- timeTracker
the synchronizer time tracker settings. don't change it unless you know what you are doing.
- initializeFromTrustedSynchronizer
if false will automatically generate a SynchronizerTrustCertificate when connecting to a new synchronizer.
Type Members
- implicit class ShowAnyRefSyntax extends AnyRef
- Definition Classes
- ShowUtil
- implicit class ShowEitherSyntax[L, R] extends AnyRef
Enables the syntax
show"${myEither.showMerged}".Enables the syntax
show"${myEither.showMerged}".- Definition Classes
- ShowUtil
- implicit class ShowLengthLimitedStringSyntax extends StringOperators
- Definition Classes
- ShowUtil
- implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
- Definition Classes
- ShowUtil
- implicit class ShowOptionSyntax[T] extends AnyRef
- Definition Classes
- ShowUtil
- implicit class ShowProductSyntax extends AnyRef
- Definition Classes
- ShowUtil
- Annotations
- @SuppressWarnings()
- implicit class ShowStringSyntax extends StringOperators
- Definition Classes
- ShowUtil
- 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
- 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
- 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
- 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
- Instances of
- def addConnection(connection: SequencerConnection): Either[String, SynchronizerConnectionConfig]
- def addEndpoints(sequencerAlias: SequencerAlias, connection: URI, additionalConnections: URI*): Either[String, SynchronizerConnectionConfig]
- def addEndpoints(sequencerAlias: SequencerAlias, connection: String, additionalConnections: String*): Either[String, SynchronizerConnectionConfig]
Helper methods to avoid having to use NonEmpty[Seq in the console
- 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()
- def companionObj: HasVersionedMessageCompanionCommon[SynchronizerConnectionConfig]
- Attributes
- protected
- Definition Classes
- SynchronizerConnectionConfig → HasVersionedWrapper
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- 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
- val initialRetryDelay: Option[NonNegativeFiniteDuration]
- val initializeFromTrustedSynchronizer: Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val manualConnect: Boolean
- val maxRetryDelay: Option[NonNegativeFiniteDuration]
- 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 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
- def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- 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
- def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- 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
- def pretty: Pretty[SynchronizerConnectionConfig]
Indicates how to pretty print this instance.
Indicates how to pretty print this instance. See
PrettyPrintingTestfor examples on how to implement this method.- Attributes
- protected
- Definition Classes
- SynchronizerConnectionConfig → PrettyPrinting
- def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
- Definition Classes
- PrettyUtil
- 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
- 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
- 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
- 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
- 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
- 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
- val priority: Int
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val sequencerConnections: SequencerConnections
- implicit final def showInterpolator(sc: StringContext): ShowInterpolator
- Definition Classes
- ShowSyntax
- 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
- def subsumeMerge(other: SynchronizerConnectionConfig): Either[String, SynchronizerConnectionConfig]
Merges this connection config with provided config, but only if the provided config is subsumed by this config.
Merges this connection config with provided config, but only if the provided config is subsumed by this config. The provided configuration is considered subsumed, if all its settings are also included in this configuration, with the following exceptions:
- the field
synchronizerIdmay be set in either or none of the configs, but if it's set in both, it must be the same synchronizer id. - the provided sequencer connections must all be included in this config's sequencer connections with the same sequencer alias. The SequencerConnections' sequencerId fields may be set in either or none of the two configs, but if it's set in both, it must be the same sequencer id.
- returns
either the merged configuration if the other configuration is subsumed by this configuration, or an error
- the field
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val synchronizerAlias: SynchronizerAlias
- val synchronizerId: Option[PhysicalSynchronizerId]
- val timeTracker: SynchronizerTimeTrackerConfig
- def toByteArray(version: ProtocolVersion): Array[Byte]
Yields a byte array representation of the corresponding
UntypedVersionedMessagewrapper of this instance.Yields a byte array representation of the corresponding
UntypedVersionedMessagewrapper of this instance.- Definition Classes
- HasVersionedWrapper
- def toByteString(version: ProtocolVersion): ByteString
Yields a byte string representation of the corresponding
UntypedVersionedMessagewrapper of this instance.Yields a byte string representation of the corresponding
UntypedVersionedMessagewrapper of this instance.- Definition Classes
- HasVersionedWrapper → HasVersionedToByteString
- def toProtoV30: admin.participant.v30.SynchronizerConnectionConfig
- def toProtoVersioned(version: ProtocolVersion): VersionedMessage[SynchronizerConnectionConfig]
Yields the proto representation of the class inside an
UntypedVersionedMessagewrapper.Yields the proto representation of the class inside an
UntypedVersionedMessagewrapper.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
- HasVersionedWrapper
- implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
- Definition Classes
- ToShowOps
- 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.
Finalto avoid accidental overwriting.- Definition Classes
- PrettyPrinting → AnyRef → Any
- def tryWithSequencerTrustThreshold(threshold: PositiveInt): SynchronizerConnectionConfig
- 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
- def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- 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])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withCertificates(sequencerAlias: SequencerAlias, certificates: ByteString): SynchronizerConnectionConfig
- def withPriority(priority: Int): SynchronizerConnectionConfig
- def withSubmissionRequestAmplification(submissionRequestAmplification: SubmissionRequestAmplification): SynchronizerConnectionConfig
- def writeDelimitedTo(pv: ProtocolVersion, 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.
- 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
- HasVersionedWrapper
- def writeToFile(outputFile: String, version: ProtocolVersion): Unit
Writes the byte string representation of the corresponding
UntypedVersionedMessagewrapper of this instance to a file.Writes the byte string representation of the corresponding
UntypedVersionedMessagewrapper of this instance to a file.- Definition Classes
- HasVersionedWrapper