A blocking acquisition of the lock.

Blocks until the lock has been acquired. A lock can only be acquired and attempted to be acquired once. A second attempt will fail even when the first attempt is still pending acquisition of the lock.

Internal (DB specific) blocking acquisition of the lock.

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.

Returns the list of process PIDs owning the lock.

Check if the lock is still held by this session.

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.

Returns true if the lock is already taken by another session

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

The application-specific lock ID, which remains the same for the lifetime of the lock.

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.

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

Explicitly release the lock.

Internal (DB specific) release of the lock.

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 f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

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.

Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns. Equivalent to

synchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))

Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has finished or the synchronizeWithClosingPatience has elapsed.

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.

Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

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.

A non-blocking acquisition of the lock.

Tries to acquire the lock and immediately returns true or false if the lock was acquired or not. A lock can only be acquired and attempted to be acquired once.

Internal (DB specific) non-blocking acquisition of the lock.

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.