Packages

trait InFlightSubmissionStore extends AutoCloseable

Backing store for com.digitalasset.canton.participant.protocol.submission.InFlightSubmissionTracker.

An in-flight submission is uniquely identified by its com.digitalasset.canton.ledger.participant.state.v2.ChangeId. com.digitalasset.canton.sequencing.protocol.MessageIds should be unique too, but this is not enforced by the store.

Every change to an individual submissions must execute atomically. Bulk operations may interleave arbitrarily the atomic changes of the affected individual submissions and therefore need not be atomic as a whole.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InFlightSubmissionStore
  2. AutoCloseable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def close(): Unit
    Definition Classes
    AutoCloseable
    Annotations
    @throws(classOf[java.lang.Exception])
  2. abstract def delete(submissions: Seq[InFlightReference])(implicit traceContext: TraceContext): Future[Unit]

    Deletes the referred to in-flight submissions if there are any.

    Deletes the referred to in-flight submissions if there are any.

    If the com.digitalasset.canton.sequencing.protocol.MessageId in com.digitalasset.canton.participant.store.InFlightSubmissionStore.InFlightByMessageId is not a UUID, there cannot be a matching in-flight submission because register forces a UUID for the message ID.

  3. abstract def lookup(changeIdHash: ChangeIdHash)(implicit traceContext: TraceContext): OptionT[Future, InFlightSubmission[SubmissionSequencingInfo]]

    Retrieves the in-flight submission for the given com.digitalasset.canton.ledger.participant.state.v2.ChangeId if one exists.

  4. abstract def lookupEarliest(domainId: DomainId)(implicit traceContext: TraceContext): Future[Option[CantonTimestamp]]

    Returns the earliest com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission.timeout or com.digitalasset.canton.participant.protocol.submission.SequencedSubmission.sequencingTime in the store, if any, for the given domain.

  5. abstract def lookupSequencedUptoUnordered(domainId: DomainId, sequencingTimeInclusive: CantonTimestamp)(implicit traceContext: TraceContext): Future[Seq[InFlightSubmission[SequencedSubmission]]]

    Returns all sequenced in-flight submissions on the given domain whose com.digitalasset.canton.participant.protocol.submission.SequencedSubmission.sequencingTime is no later than sequencingTimeInclusive.

    Returns all sequenced in-flight submissions on the given domain whose com.digitalasset.canton.participant.protocol.submission.SequencedSubmission.sequencingTime is no later than sequencingTimeInclusive.

    The in-flight submissions are not returned in any specific order.

  6. abstract def lookupSomeMessageId(domainId: DomainId, messageId: MessageId)(implicit traceContext: TraceContext): Future[Option[InFlightSubmission[SubmissionSequencingInfo]]]

    Returns one of the in-flight submissions with the given com.digitalasset.canton.topology.DomainId and com.digitalasset.canton.sequencing.protocol.MessageId, if any.

  7. abstract def lookupUnsequencedUptoUnordered(domainId: DomainId, observedSequencingTime: CantonTimestamp)(implicit traceContext: TraceContext): Future[Seq[InFlightSubmission[UnsequencedSubmission]]]

    Returns all unsequenced in-flight submissions on the given domain whose com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission.timeout is no later than observedSequencingTime.

    Returns all unsequenced in-flight submissions on the given domain whose com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission.timeout is no later than observedSequencingTime.

    The in-flight submissions are not returned in any specific order.

  8. abstract def observeSequencedRootHash(rootHash: RootHash, submission: SequencedSubmission)(implicit traceContext: TraceContext): Future[Unit]

    Moves the submission with the given com.digitalasset.canton.protocol.RootHash from com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission to com.digitalasset.canton.participant.protocol.submission.SequencedSubmission.

    Moves the submission with the given com.digitalasset.canton.protocol.RootHash from com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission to com.digitalasset.canton.participant.protocol.submission.SequencedSubmission.

    If a com.digitalasset.canton.participant.protocol.submission.SequencedSubmission with the given com.digitalasset.canton.protocol.RootHash already exists:

    • if the given submission was sequenced earlier than the existing one, it replaces it;
    • otherwise, this call will be ignored.

    As this method is called from the asynchronous part of message processing, this behavior ensures that the in-flight submission tracker always ends up tracking the earliest request for a given com.digitalasset.canton.protocol.RootHash, independently of the order in which these calls are made, in accordance with the replay prevention mechanism.

    If the later request writes first, the InFlightSubmissionStore contains stale data for the submission request until the earlier request updates the row. This is fine because the stale information will only be read by the com.digitalasset.canton.participant.protocol.submission.InFlightSubmissionTracker after the corresponding completion event has been published by the com.digitalasset.canton.participant.event.RecordOrderPublisher. However, this happens only after the earlier request has signalled its tick, i.e., when Phase 3 has finished (via the com.digitalasset.canton.participant.protocol.Phase37Synchronizer and either a com.digitalasset.canton.protocol.messages.MediatorResult has been processed or the decision time has elapsed. By this time, the row with the stale data has been overwritten by the earlier request.

    Calls to this method also race with calls to observeSequencing for later messages, e.g., if a submission request gets preplayed without a message ID. The argument about the stale data being benign also applies to those races. There are no races between several calls to observeSequencing because observeSequencing is called sequentially for each batch of sequenced events.

  9. abstract def observeSequencing(domainId: DomainId, submissions: Map[MessageId, SequencedSubmission])(implicit traceContext: TraceContext): Future[Unit]

    Moves the submissions to the given domain with the given com.digitalasset.canton.sequencing.protocol.MessageIds from com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission to com.digitalasset.canton.participant.protocol.submission.SequencedSubmission.

  10. abstract def register(submission: InFlightSubmission[UnsequencedSubmission]): EitherT[FutureUnlessShutdown, InFlightSubmission[SubmissionSequencingInfo], Unit]

    Registers the given submission as being in flight and unsequenced unless there already is an in-flight submission for the same change ID.

    Registers the given submission as being in flight and unsequenced unless there already is an in-flight submission for the same change ID.

    This method MUST NOT run concurrently with a delete query for the same change ID and message ID. When this method fails with an exception, it is unknown whether the submission was registered.

    returns

    A scala.Left$ of the existing in-flight submission with the same change ID and a different com.digitalasset.canton.sequencing.protocol.MessageId if there is any.

  11. abstract def updateRegistration(submission: InFlightSubmission[UnsequencedSubmission], rootHash: RootHash)(implicit traceContext: TraceContext): Future[Unit]

    Updates the registration of the given unsequenced submission with its root hash information.

    Updates the registration of the given unsequenced submission with its root hash information.

    If the root hash for the given submission has already been set by a previous call to this method, the new update will be ignored. If the given submission is not found in the store, the update will be ignored. We don't report an error because it can happen e.g. if the max sequencing time has already elapsed and the timely rejection published.

    This is done as a separate operation from register because the root hash is currently not known at registration time.

  12. abstract def updateUnsequenced(changeId: ChangeIdHash, submissionDomain: DomainId, messageId: MessageId, newSequencingInfo: UnsequencedSubmission)(implicit traceContext: TraceContext): Future[Unit]

    Update the in-flight submission identified by the given changeId if submissionDomain and messageId match and it is unsequenced and the existing com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission.timeout is not earlier than the newSequencingInfo's com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission.timeout.

    Update the in-flight submission identified by the given changeId if submissionDomain and messageId match and it is unsequenced and the existing com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission.timeout is not earlier than the newSequencingInfo's com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission.timeout. Only the field com.digitalasset.canton.participant.protocol.submission.InFlightSubmission.sequencingInfo is updated.

    This is useful to change when and how a rejection is reported, e.g., if the submission logic decided to not send the com.digitalasset.canton.sequencing.protocol.SubmissionRequest to the sequencer after all.

Concrete 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. 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 AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped