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

The approximate timestamp

This is either the last observed sequencer timestamp OR the effective timestamp after we observed the time difference of (effective - sequencer = epsilon)

Finds the transaction with maximum effective time that has been sequenced before or at sequencedTime and yields the sequenced / effective time of that transaction. Potentially waits for sequencedTime to be observed.

Returns an optional future which will complete when the sequenced timestamp has been observed

If the timestamp is already observed, returns None.

Waits until a snapshot is available

The snapshot returned by this method should be used for validating transaction and reassignment requests (Phase 2 - 7). Use the request timestamp as parameter for this method. Do not use a response or result timestamp, because all validation steps must use the same topology snapshot.

Supervised version of awaitSnapshot

Returns an optional future which will complete when the effective timestamp has been observed

If the timestamp is already observed, returns None.

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

Our current snapshot approximation

As topology transactions are future dated (to prevent sequential bottlenecks), we do have to "guess" the current state, as time is defined by the sequencer after we've sent the transaction. Therefore, this function will return the best snapshot approximation known.

The snapshot returned by this method should be used when preparing a transaction or reassignment request (Phase 1). It must not be used when validating a request (Phase 2 - 7); instead, use one of the snapshot methods with the request timestamp.

Possibly future dated head snapshot

As we future date topology transactions, the head snapshot is our latest knowledge of the topology state, but as it can be still future dated, we need to be careful when actually using it: the state might not yet be active, as the topology transactions are future dated. Therefore, do not act towards the sequencer using this snapshot, but use the currentSnapshotApproximation instead.

Returns a snapshot of the current member topology for the given synchronizer. The future will log a warning and await the snapshot if the data is not there yet.

The snapshot returned by this method should be used for validating transaction and transfer requests (Phase 2 - 7). Use the request timestamp as parameter for this method. Do not use a response or result timestamp, because all validation steps must use the same topology snapshot.

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.

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

The synchronizer this client applies to

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.

Returns the topology information at a certain point in time

Use this method if you are sure to be synchronized with the topology state updates. The method will block & wait for an update, but emit a warning if it is not available

The snapshot returned by this method should be used for validating transaction and reassignment requests (Phase 2 - 7). Use the request timestamp as parameter for this method. Do not use a response or result timestamp, because all validation steps must use the same topology snapshot.

Returns true if the topology information at the passed timestamp is already known

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.

The most recently observed effective timestamp

The effective timestamp is sequencer_time + epsilon(sequencer_time), where epsilon is given by the topology change delay time, defined using the synchronizer parameters.

This is the highest timestamp for which we can serve snapshots

Returns the topology information at a certain point in time

Fails with an exception if the state is not yet known.

The snapshot returned by this method should be used for validating transaction and reassignment requests (Phase 2 - 7). Use the request timestamp as parameter for this method. Do not use a response or result timestamp, because all validation steps must use the same topology snapshot.

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.