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.

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.

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

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.

Process incoming commitments.

The caller(s) must jointly ensure that all incoming commitments are passed to this method, in their order of arrival. Upon startup, the method must be called on all incoming commitments whose processing hasn't finished yet, including those whose processing has been aborted due to shutdown.

There is no special catch-up logic on the incoming queue, because processing was never a bottleneck here. However, the incoming queue is important because it gives us the condition to initiate catch-up by allowing us to look at the timestamp of received commitments.

Should processing of incoming commitments become a bottleneck, we can do the following:

• to quickly detect a possible catch-up condition, we validate incoming commitments (including signature) as they come and store them; the catch-up condition looks at the timestamp of incoming commitments in the queue
• to enable match checks of local and remote commitments, in a separate thread continue processing the commitments by checking matches and buffering them if needed.
  • during catch-up, the processing order is first commitments at catch-up boundaries in increasing timestamp order, then other commitments in increasing timestamp order
  • outside catch-up, process commitments as they come

ACS change notification. Any response logic needs to happen in the background. The ACS change set may be empty, (e.g., in case of time proofs).

Reinitialize the running commitments at the given ACS timestamp. This is used to recompute the running commitments from the active contract store. Because the reinitialization task runs on the queue, a reinitialization cannot start before a previous initialization finished.

Returns false if a reinitialization is already enqueued or executing, true otherwise.

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.