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.

Removes a shutdown task from the list using a token returned by runOnShutdown

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

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

track running futures on shutdown

set to true to get detailed information about all futures that did not complete during shutdown. if set to false, we don't do anything.

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

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.

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.

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.

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.

Explicitly release the lock.

Internal (DB specific) release of the lock.

Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

Register a task to run when shutdown is initiated.

You can use this for example to register tasks that cancel long-running computations, whose termination you can then wait for in "closeAsync".

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.