TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

Blocks until all earlier tasks have completed and then prevents further tasks from being run.

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.

Check whether we're closing. Susceptible to race conditions; unless you're using this as a flag to the retry lib or you really know what you're doing, prefer performUnlessClosing and friends.

Set this to true to get detailed information about all futures that did not complete during shutdown.

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

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 synchronizer.

Returns all sequenced in-flight submissions on the given synchronizer 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.

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

Returns all unsequenced in-flight submissions on the given synchronizer 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.

How often to poll to check that all tasks have completed.

Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed. This allows proper clean up of stray promises when the node is transitioning to a passive state.

Note: you should *not* invoke success on the returned promise but rather use trySuccess. The reason is that the call to success may fail in case of shutdown.

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.ConfirmationResultMessage 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.

Moves the submissions to the given synchronizer 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.

Blocks until all earlier tasks have completed and then prevents further tasks from being run.

Performs the task given by f unless a shutdown has been initiated. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, if started using this function, or one of the other variants (performUnlessClosingF and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.

DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead. Both etf and the error are lazy; etf is only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin after etf completes, but other tasks may execute concurrently with etf, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingF). The tasks are assumed to take less than closingTimeout to complete.

DO NOT CALL this.close as part of etf, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

Performs the Future given by f unless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.

DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

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.

TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

Schedules the given task to be run upon closing.

Register a task to run when closing is initiated, or run it immediately if closing is already ongoing. Unlike runOnClose, this method does not guarantee that this task will have run by the time the LifeCycleManager's closeAsync method completes or AutoCloseable's close returns. This is because the task is run immediately if the component has already been closed.

Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.

Runs the computation fa unless isClosing returns true.

This method does not delay the closing while fa is running, unlike the methods in HasSynchronizeWithClosing. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.

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.

Update the in-flight submission identified by the given changeId if submissionSynchronizerId 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.