Packages

trait TrackedSubmission extends Submission

Submission to be tracked in-flight and with deduplication.

The actual batch to be sent is computed only later by TrackedSubmission.prepareBatch so that tracking information (e.g., the chosen deduplication period) can be incorporated into the batch.

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

Abstract Value Members

  1. abstract def changeIdHash: ChangeIdHash

    Change id hash to be used for deduplication of requests.

  2. abstract def commandDeduplicationFailure(failure: DeduplicationFailed): SubmissionTrackingData

    The submission tracking data to be used in case command deduplication failed

  3. abstract def embedInFlightSubmissionTrackerError(error: InFlightSubmissionTrackerError): SubmissionError

    Convert a com.digitalasset.canton.participant.protocol.submission.InFlightSubmissionTracker.InFlightSubmissionTrackerError into a SubmissionError to be returned by the com.digitalasset.canton.participant.protocol.ProtocolProcessor.submit method.

  4. abstract def embedSequencerRequestError(error: SequencerRequestError): SubmissionSendError
  5. abstract def maxSequencingTimeO: OptionT[Future, CantonTimestamp]

    Optional timestamp for the max sequencing time of the event.

    Optional timestamp for the max sequencing time of the event.

    If possible, set it to the upper limit when the event could be successfully processed. If scala.None, then the sequencer client default will be used.

    Definition Classes
    Submission
  6. abstract def onFailure: SubmissionResult

    The SubmissionResult to return if something went wrong after having registered the submission for tracking.

    The SubmissionResult to return if something went wrong after having registered the submission for tracking. This result must not generate a completion event.

    Must not throw an exception.

  7. abstract def prepareBatch(actualDeduplicationOffset: DeduplicationOffset, maxSequencingTime: CantonTimestamp, sessionKeyStore: SessionKeyStore): EitherT[FutureUnlessShutdown, SubmissionTrackingData, PreparedBatch]

    Phase 1, step 1a

    Phase 1, step 1a

    Prepare the batch of envelopes to be sent off given the com.digitalasset.canton.ledger.api.DeduplicationPeriod.DeduplicationOffset chosen by in-flight submission tracking and deduplication.

    Errors will be reported asynchronously by updating the com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission for the changeIdHash.

    Must not throw an exception.

    actualDeduplicationOffset

    The deduplication offset chosen by command deduplication

  8. abstract def shutdownDuringInFlightRegistration: SubmissionError

    Produce a SubmissionError to be returned by the com.digitalasset.canton.participant.protocol.ProtocolProcessor.submit method to indicate that a shutdown has happened during in-flight registration.

    Produce a SubmissionError to be returned by the com.digitalasset.canton.participant.protocol.ProtocolProcessor.submit method to indicate that a shutdown has happened during in-flight registration. The resulting SubmissionError must convey neither that the submission is in-flight nor that it is not in-flight.

  9. abstract def specifiedDeduplicationPeriod: DeduplicationPeriod

    The deduplication period for the submission as specified in the com.digitalasset.canton.ledger.participant.state.v2.SubmitterInfo

  10. abstract def submissionId: Option[LedgerSubmissionId]

    The submission ID of the submission, optional.

  11. abstract def submissionTimeoutTrackingData: SubmissionTrackingData

    The tracking data for the submission to be persisted.

    The tracking data for the submission to be persisted. If the submission is not sequenced by the max sequencing time, this data will be used to generate a timely rejection event via com.digitalasset.canton.participant.protocol.submission.SubmissionTrackingData.rejectionEvent.

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 Submission

Inherited from AnyRef

Inherited from Any

Ungrouped