final case class InFlightSubmission[+SequencingInfo <: SubmissionSequencingInfo](changeIdHash: ChangeIdHash, submissionId: Option[LedgerSubmissionId], submissionDomain: DomainId, messageUuid: UUID, rootHashO: Option[RootHash], sequencingInfo: SequencingInfo, submissionTraceContext: TraceContext) extends PrettyPrinting with Product with Serializable

Collects information about an in-flight submission, to be stored in com.digitalasset.canton.participant.store.InFlightSubmissionStore.

changeIdHash

The identifier for the intended ledger change. We only include the hash instead of the com.digitalasset.canton.ledger.participant.state.v2.ChangeId so that we do not need to persist and reconstruct the actual contents of the com.digitalasset.canton.ledger.participant.state.v2.ChangeId when we read an InFlightSubmission from the store.

submissionId

Optional submission id.

submissionDomain

The domain to which the submission is supposed to be/was sent.

messageUuid

The message UUID that will be/has been used for the com.digitalasset.canton.sequencing.protocol.SubmissionRequest

rootHashO

The root hash contained in the com.digitalasset.canton.sequencing.protocol.SubmissionRequest. Optional because:

  • currently, the root hash is not available when creating an entry for registration, and is added as a second step;
  • it can be an older entry for which the root hash was never added.
sequencingInfo

Information about when the request will be/was sequenced

submissionTraceContext

The com.digitalasset.canton.tracing.TraceContext of the submission.

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

Instance Constructors

  1. new InFlightSubmission(changeIdHash: ChangeIdHash, submissionId: Option[LedgerSubmissionId], submissionDomain: DomainId, messageUuid: UUID, rootHashO: Option[RootHash], sequencingInfo: SequencingInfo, submissionTraceContext: TraceContext)

    changeIdHash

    The identifier for the intended ledger change. We only include the hash instead of the com.digitalasset.canton.ledger.participant.state.v2.ChangeId so that we do not need to persist and reconstruct the actual contents of the com.digitalasset.canton.ledger.participant.state.v2.ChangeId when we read an InFlightSubmission from the store.

    submissionId

    Optional submission id.

    submissionDomain

    The domain to which the submission is supposed to be/was sent.

    messageUuid

    The message UUID that will be/has been used for the com.digitalasset.canton.sequencing.protocol.SubmissionRequest

    rootHashO

    The root hash contained in the com.digitalasset.canton.sequencing.protocol.SubmissionRequest. Optional because:

    • currently, the root hash is not available when creating an entry for registration, and is added as a second step;
    • it can be an older entry for which the root hash was never added.
    sequencingInfo

    Information about when the request will be/was sequenced

    submissionTraceContext

    The com.digitalasset.canton.tracing.TraceContext of the submission.

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 changeIdHash: ChangeIdHash
  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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. 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
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def isSequenced: Boolean

    Whether the submission's sequencing has been observed

  14. def mapSequencingInfo[B <: SubmissionSequencingInfo](f: (SequencingInfo) => B): InFlightSubmission[B]
  15. def messageId: MessageId
  16. val messageUuid: UUID
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. 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
  21. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  22. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  23. 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
  24. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  25. 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
  26. def pretty: Pretty[InFlightSubmission.this.type]

    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
    InFlightSubmissionPrettyPrinting
  27. def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
    Definition Classes
    PrettyUtil
  28. 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
  29. 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
  30. 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
  31. 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
  32. 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
  33. def productElementNames: Iterator[String]
    Definition Classes
    Product
  34. def referenceByMessageId: InFlightByMessageId
  35. def referenceBySequencingInfo(implicit ev: <:<[SequencingInfo, SequencedSubmission]): InFlightBySequencingInfo
  36. val rootHashO: Option[RootHash]
  37. val sequencingInfo: SequencingInfo
  38. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  39. 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
  40. val submissionDomain: DomainId
  41. val submissionId: Option[LedgerSubmissionId]
  42. val submissionTraceContext: TraceContext
  43. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  44. def timelyRejectionEventId(implicit ev: <:<[SequencingInfo, UnsequencedSubmission]): TimelyRejectionEventId

    ev

    Enforces that this method is called only on unsequenced in-flight submissions as there is no point in talking about timely rejections for sequenced submissions.

  45. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  46. 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
  47. def traverseSequencingInfo[F[_], B <: SubmissionSequencingInfo](f: (SequencingInfo) => F[B])(implicit F: Functor[F]): F[InFlightSubmission[B]]
  48. 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
  49. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  50. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  51. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  52. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  53. 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
    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