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

Decrypts an encrypted message using the referenced private encryption key

Generates a new encryption key pair with the given scheme and optional name, stores the private key and returns the public key.

Internal method to generate and return the entire encryption key pair

Generates a new signing key pair with the given scheme and optional name, stores the private key and returns the public key.

Internal method to generate and return the entire signing key pair

Returns the current state

The initial state upon creation

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.

Name of the health element. Used for logging.

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

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

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.

Signs the given hash using the referenced private signing key.

Signs the byte string directly, however it is encouraged to sign a hash.

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.

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.