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

Parameters to control prune batching

If defined, then the pruning window will be computed such that it targets the ideal target batch size in order to optimize the load on the database.

This is currently used with the journal stores. Normal pruning of other stores already does batching on its own.

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

Actual invocation of doPrune

Finds for a counter participant all stored computed commitments whose period overlaps with the given period.

No guarantees on the order of the returned commitments.

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.

Last locally processed timestamp.

Upon crash-recovery, it is safe to resubscribe to the sequencer starting after the returned timestamp.

Marks a period as processed and thus its end as a safe point for crash-recovery.

To be called by the ACS commitment processor only.

The period must be after the time point returned by lastComputedAndSent.

Marks a period for all counter participant as cleared by multi-hosted party tracking.

Caller needs to ensure the periods are valid.

Idempotent behavior.

Any period marked by this will be considered fine to prune for the noOutstandingCommitments.

Mark that remote commitments are outstanding for a period

Caller needs to ensure the periods are valid.

Mark a period with the given commitment match state for a counter participant. To be called by the ACS commitment processor only.

Caller needs to ensure the periods are valid.

May be called with the same parameters again, after a restart or a synchronizer reconnect. Marking a period may change return value of outstanding.

Any state (i.e., Match, Mismatch, Outstanding) overwrites Outstanding, and only state Matched overwrites state Mismatch.

Mark a period as safe for a counterparticipant. To be called by the ACS commitment processor only.

Caller needs to ensure the periods are valid.

"Safe" here means that the received commitment matches the locally computed commitment. The toInclusive field of the period must not be higher than that of the last period passed to markComputedAndSent.

May be called with the same parameters again, after a restart or a synchronizer reconnect.

Marking a period as safe may change the result of calling outstanding.

Mark a period as unsafe for a counterparticipant. To be called by the ACS commitment processor only.

Caller needs to ensure the periods are valid.

"Unsafe" here means that the received commitment does not match the locally computed commitment. The toInclusive field of the period must not be higher than that of the last period passed to markComputedAndSent.

May be called with the same parameters again, after a restart or a synchronizer reconnect.

Marking a period as unsafe may change the result of calling outstanding.

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.

The latest timestamp before or at the given timestamp for which no commitments are outstanding. A list of com.digitalasset.canton.pruning.ConfigForNoWaitCounterParticipants can be given for counter participants that should not be considered. It is safe to prune the synchronizer at the returned timestamp as long as it is not before the last timestamp needed for crash recovery (see com.digitalasset.canton.participant.pruning.PruningProcessor.latestSafeToPruneTick)

Returns None if no such tick is known.

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

Inspection: find periods for which commitments are still outstanding, and from whom.

The returned periods may overlap.

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.

Prune all unnecessary data relating to events before the given timestamp.

The meaning of "unnecessary", and whether the limit is inclusive or exclusive both depend on the particular store. The store must implement the actual pruning logic in the doPrune method.

Returns the latest timestamp at which pruning was started or completed. For com.digitalasset.canton.pruning.PruningPhase.Started, it is guaranteed that no pruning has been run on the store after the returned timestamp. For com.digitalasset.canton.pruning.PruningPhase.Completed, it is guaranteed that the store is pruned at least up to the returned timestamp (inclusive). That is, another pruning with the returned timestamp (or earlier) has no effect on the store. Returns scala.None$ if no pruning has ever been started on the store.

The table name to store the pruning timestamp in. The table must define the following fields:

• partitionColumn primary key
• phase stores the com.digitalasset.canton.pruning.PruningPhase
• ts stores the com.digitalasset.canton.data.CantonTimestamp

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.

Inspection: search computed commitments applicable to the specified period (start is exclusive, end is inclusive)

Inspection: search received commitments applicable to the specified period (start is exclusive, end is inclusive)

Store a locally computed ACS commitment. To be called by the ACS commitment processor only.

If the method is called twice with the same period and counter participant, then the supplied commitments must be the same too. Otherwise, the future fails.

The implementation is guaranteed to be idempotent: calling it twice with the same argument doesn't change the system's behavior compared to calling it only once.

Store a received ACS commitment. To be called by the ACS commitment processor only.

The implementation is guaranteed to be idempotent: calling it twice with the same argument doesn't change the store's behavior compared to calling it only once.

The callers are free to insert multiple different commitments for the same commitment period; all of them will be stored (but will be deduplicated). This can be used in case the commitment sender is malicious or buggy, and sends both a correct and an incorrect commitment for the same time period. The caller can still store both commitments, for example, such that it can later prove to a third party that the sender sent an incorrect commitment.

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.