Packages

final case class CausalityMessage(domainId: DomainId, transferId: TransferId, clock: VectorClock)(representativeProtocolVersion: RepresentativeProtocolVersion[ProtocolMessage]) extends ProtocolMessage with PrettyPrinting with ProtocolMessageV0 with ProtocolMessageV1 with Product with Serializable

Causality messages are sent along with a transfer-in response. They propagate causality information on the events a participant has "seen" for a party at the time of the transfer-out. TODO(i9514): Encrypt the causality messages

domainId

The domain ID that the causality message is addressed to

transferId

The ID of the transfer for which we are propagating causality information

clock

The vector clock specifying causality information at the time of the transfer out

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CausalityMessage
  2. ProtocolMessageV1
  3. ProtocolMessageV0
  4. ProtocolMessage
  5. HasRepresentativeProtocolVersion
  6. PrettyPrinting
  7. PrettyUtil
  8. ShowUtil
  9. ShowSyntax
  10. ToShowOps
  11. HasDomainId
  12. Serializable
  13. Product
  14. Equals
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CausalityMessage(domainId: DomainId, transferId: TransferId, clock: VectorClock)(representativeProtocolVersion: RepresentativeProtocolVersion[ProtocolMessage])

    domainId

    The domain ID that the causality message is addressed to

    transferId

    The ID of the transfer for which we are propagating causality information

    clock

    The vector clock specifying causality information at the time of the transfer out

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val clock: VectorClock
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. 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
  9. val domainId: DomainId

    The ID of the domain over which this message is supposed to be sent.

    The ID of the domain over which this message is supposed to be sent.

    Definition Classes
    CausalityMessageProtocolMessageHasDomainId
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. 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
  17. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  18. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  19. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  20. 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
  21. def pretty: Pretty[CausalityMessage.this.type]

    By default prints only the object name as a trade-off for shorter long lines and not leaking confidential data.

    By default prints only the object name as a trade-off for shorter long lines and not leaking confidential data. Sub-classes may override the pretty instance to print more information.

    Definition Classes
    CausalityMessageProtocolMessagePrettyPrinting
  22. def prettyInfix[T, U, V](first: (T) => U, infixOp: String, second: (T) => V)(implicit arg0: Pretty[U], arg1: Pretty[V]): Pretty[T]
    Definition Classes
    PrettyUtil
  23. 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
  24. 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
  25. 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
  26. 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
  27. 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
  28. def productElementNames: Iterator[String]
    Definition Classes
    Product
  29. val representativeProtocolVersion: RepresentativeProtocolVersion[ProtocolMessage]
  30. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  31. 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
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. def toProtoEnvelopeContentV0: v0.EnvelopeContent
    Definition Classes
    CausalityMessageProtocolMessageV0
  34. def toProtoEnvelopeContentV1: v1.EnvelopeContent
    Definition Classes
    CausalityMessageProtocolMessageV1
  35. def toProtoV0: v0.CausalityMessage
  36. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  37. 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
  38. val transferId: TransferId
  39. 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
  40. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  41. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from ProtocolMessageV1

Inherited from ProtocolMessageV0

Inherited from ProtocolMessage

Inherited from PrettyPrinting

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from HasDomainId

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped