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

The com.digitalasset.canton.lifecycle.HasRunOnClosing associated with this object.

When this com.digitalasset.canton.lifecycle.HasRunOnClosing closes, the health state permanently becomes closingState and all listeners are notified about this.

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

The state set when the associatedHasRunOnClosing closes

Report that the component is now degraded. Note that this will override the component state, even if it is currently failed!

Report that the component is now degraded. Note that this will override the component state, even if it is currently failed!

Report that the component is now failed

Report that the component is now failed

Report that the component is now fatally failed and the system should be restarted.

Returns the current state

The initial state upon creation

Indicates if the storage instance is active and ready to perform updates/writes.

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.

Returns database specific limit [offset] clause. Safe to use in a select slick query with #$... interpolation

Automatically performs #$ interpolation for a call to limit

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

Name of the health element. Used for logging.

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.

Query and update in a single action.

Note that the action is not transactional by default, but can be made so via using queryAndUpdate(action.transactionally..withTransactionIsolation(Serializable), "name")

The action must be idempotent because it may be retried multiple times. Only the result of the last retry will be reported. If the action reports the number of rows changed, this number may be lower than actual number of affected rows because updates from earlier retries are not accounted.

Triggers a refresh of the component's state, using newState to determine the new state. May return before the newState has been evaluated and the listeners have been poked.

Note that listeners need not be poked about every state change; it suffices that they are poked eventually after each state change. So if there are frequent updates to the state, possibly from concurrent calls, then the listeners may never see some intermediate states.

Registers a high priority listener that gets poked upon each change of this element's health state. This listener will be run before listeners registered via registerOnHealthChange

Registers a listener that gets poked upon each change of this element's health state.

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

Sets the state of this component and notifies its listeners

Set the health state to Ok and if the previous state was unhealthy, log a message to inform about the resolution of the ongoing issue.

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.

Unregisters a listener.

Write-only action, possibly transactional

The action must be idempotent because it may be retried multiple times. Only the result of the last retry will be reported. If the action reports the number of rows changed, this number may be lower than actual number of affected rows because updates from earlier retries are not accounted.

Write-only action, possibly transactional The action must be idempotent because it may be retried multiple times.

Runs the given query transactionally with synchronous commit replication if the database provides the ability to configure synchronous commits per transaction.

Currently only Postgres supports this.