final case class DomainConnectionConfig(domain: DomainAlias, sequencerConnections: SequencerConnections, manualConnect: Boolean = false, domainId: Option[DomainId] = None, priority: Int = 0, initialRetryDelay: Option[NonNegativeFiniteDuration] = None, maxRetryDelay: Option[NonNegativeFiniteDuration] = None, timeTracker: DomainTimeTrackerConfig = DomainTimeTrackerConfig()) extends HasVersionedWrapper[DomainConnectionConfig] with PrettyPrinting with Product with Serializable

The domain connection configuration object

domain

alias to be used internally to refer to this domain connection

sequencerConnections

Configuration for the sequencers. In case of BFT domain - 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 domain is not connected automatically on startup.

domainId

if the domain-id is known, then it can be passed as an argument. during the handshake, the participant will check that the domain-id on the remote port is indeed the one given in the configuration. the domain-id can not be faked by a domain. therefore, this additional check can be used to really ensure that you are talking to the right domain.

priority

the priority of this domain connection. if there are more than one domain connections, the com.digitalasset.canton.participant.protocol.submission.routing.DomainRouter will pick the domain connection with the highest priority if possible.

initialRetryDelay

domain connections are "resilient". i.e. if a connection is lost, the system will keep trying to reconnect to a domain.

maxRetryDelay

control the backoff parameter such that the retry interval does not grow above this value

timeTracker

the domain time tracker settings. don't change it unless you know what you are doing.

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

Instance Constructors

  1. new DomainConnectionConfig(domain: DomainAlias, sequencerConnections: SequencerConnections, manualConnect: Boolean = false, domainId: Option[DomainId] = None, priority: Int = 0, initialRetryDelay: Option[NonNegativeFiniteDuration] = None, maxRetryDelay: Option[NonNegativeFiniteDuration] = None, timeTracker: DomainTimeTrackerConfig = DomainTimeTrackerConfig())

    domain

    alias to be used internally to refer to this domain connection

    sequencerConnections

    Configuration for the sequencers. In case of BFT domain - 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 domain is not connected automatically on startup.

    domainId

    if the domain-id is known, then it can be passed as an argument. during the handshake, the participant will check that the domain-id on the remote port is indeed the one given in the configuration. the domain-id can not be faked by a domain. therefore, this additional check can be used to really ensure that you are talking to the right domain.

    priority

    the priority of this domain connection. if there are more than one domain connections, the com.digitalasset.canton.participant.protocol.submission.routing.DomainRouter will pick the domain connection with the highest priority if possible.

    initialRetryDelay

    domain connections are "resilient". i.e. if a connection is lost, the system will keep trying to reconnect to a domain.

    maxRetryDelay

    control the backoff parameter such that the retry interval does not grow above this value

    timeTracker

    the domain time tracker settings. don't change it unless you know what you are doing.

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 show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    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. 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
  5. def addConnection(connection: SequencerConnection): DomainConnectionConfig
  6. def addEndpoints(sequencerAlias: SequencerAlias, connection: URI, additionalConnections: URI*): DomainConnectionConfig
  7. def addEndpoints(sequencerAlias: SequencerAlias, connection: String, additionalConnections: String*): DomainConnectionConfig

    Helper methods to avoid having to use NonEmpty[Seq in the console

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  10. def companionObj: HasVersionedMessageCompanionCommon[DomainConnectionConfig]
    Attributes
    protected
    Definition Classes
    DomainConnectionConfigHasVersionedWrapper
  11. 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
  12. val domain: DomainAlias
  13. val domainId: Option[DomainId]
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  16. 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
  17. val initialRetryDelay: Option[NonNegativeFiniteDuration]
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. val manualConnect: Boolean
  20. val maxRetryDelay: Option[NonNegativeFiniteDuration]
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  24. 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
  25. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  26. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  27. 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
  28. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  29. 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
  30. def pretty: Pretty[DomainConnectionConfig]

    Indicates how to pretty print this instance.

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

    Definition Classes
    DomainConnectionConfigPrettyPrinting
  31. def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
    Definition Classes
    PrettyUtil
  32. 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
  33. 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
  34. 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
  35. 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
  36. 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
  37. val priority: Int
  38. def productElementNames: Iterator[String]
    Definition Classes
    Product
  39. val sequencerConnections: SequencerConnections
  40. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  41. 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
  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. val timeTracker: DomainTimeTrackerConfig
  44. def toByteArray(version: ProtocolVersion): 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
    HasVersionedWrapper
  45. def toByteString(version: ProtocolVersion): 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
    HasVersionedWrapperHasVersionedToByteString
  46. def toProtoV0: admin.v0.DomainConnectionConfig
  47. def toProtoVersioned(version: ProtocolVersion): VersionedMessage[DomainConnectionConfig]

    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
    HasVersionedWrapper
  48. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  49. 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
  50. 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
  51. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  52. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  55. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. def withCertificates(sequencerAlias: SequencerAlias, certificates: ByteString): DomainConnectionConfig
  57. def writeToFile(outputFile: String, version: ProtocolVersion = ProtocolVersion.latestStable): Unit

    Writes the byte string representation of the corresponding UntypedVersionedMessage wrapper of this instance to a file.

    Writes the byte string representation of the corresponding UntypedVersionedMessage wrapper of this instance to a file.

    Definition Classes
    HasVersionedWrapper

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

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 AnyRef

Inherited from Any

Ungrouped