t

com.digitalasset.canton.lifecycle

PerformUnlessClosing

trait PerformUnlessClosing extends OnShutdownRunner with HasSynchronizeWithReaders

Provides a way to synchronize closing with other running tasks in the class, such that new tasks aren't scheduled while closing, and such that closing waits for the scheduled tasks.

Use this type to pass such synchronization objects to other objects that merely need to synchronize, but should not be able to initiate closing themselves. To that end, this trait does not expose the java.lang.AutoCloseable.close method.

Self Type
PerformUnlessClosing with AutoCloseable
See also

FlagCloseable does expose the java.lang.AutoCloseable.close method.

Linear Supertypes
HasSynchronizeWithReaders, OnShutdownRunner, HasRunOnClosing, HasUnlessClosing, AnyRef, Any
Known Subclasses
AcsCommitmentBenchmarkCaching, AcsCommitmentBenchmarkContractTypes, RegisterTopologyTransactionHandle, SequencerBasedRegisterTopologyTransactionHandle, GrpcSequencerConnectClient, ExecutionContextMonitor, ConsoleEnvironment, Crypto, CryptoPrivateApi, CryptoPrivateStoreApi, SynchronizerCryptoClient, Kms, AwsKms, DriverKms, GcpKms, JcePrivateCrypto, KmsPrivateCrypto, EncryptedCryptoPrivateStore, DbCryptoPrivateStore, DbCryptoPublicStore, DbKmsMetadataStore, TaskScheduler, DemoRunner, BootstrapStage, BootstrapStageOrLeaf, BootstrapStageWithStorage, CantonNodeBootstrap, CantonNodeBootstrapImpl, ManagedNodes, MediatorNodes, Nodes, ParticipantNodes, RunningNode, SequencerNodes, CloseableAtomicHealthComponent, CloseableHealthComponent, CloseableHealthElement, CloseableHealthQuasiComponent, DelegatingMutableHealthComponent, DelegatingMutableHealthQuasiComponent, DependenciesHealthService, GrpcHealthServer, HealthService, HttpHealthServer, LivenessHealthService, MutableHealthComponent, MutableHealthQuasiComponent, LedgerSubscription, ResilientLedgerSubscription, DefaultPromiseUnlessShutdownFactory, FlagCloseable, FlagCloseableAsync, SequencerBenchmark, StorageWithDedicatedDatabase, ParticipantNodeBootstrap, AdminWorkflowServices, PackageDependencyResolver, PackageService, PackageUploader, PingService, PartyReplicationAdminWorkflow, PartyReplicator, CommitmentsService, RepairService, RecordOrderPublisher, LedgerApiServerState, LedgerApiIndexer, LedgerApiStore, StartableStoppableLedgerApiServer, CommandSubmitterWithRetry, AbstractMessageProcessor, BadRootHashMessagesRequestProcessor, Phase37Synchronizer, ProtocolProcessor, ReassignmentSynchronizer, SubmissionTrackerImpl, TransactionProcessor, PartyReplicationSourceParticipantProcessor, PartyReplicationTargetParticipantProcessor, AssignmentProcessor, UnassignmentProcessor, TransactionRoutingProcessor, AcsCommitmentBenchmark, AcsCommitmentBenchmarkCatchupConfig, AcsCommitmentBenchmarkLoad, AcsCommitmentMultiHostedPartyTracker, AcsCommitmentProcessor, PruningProcessor, ParticipantReplicaManager, ParticipantPruningScheduler, ContractStore, ParticipantNodePersistentState, DbAcsCommitmentConfigStore, DbAcsCommitmentStore, DbActiveContractStore, DbCommandDeduplicationStore, DbCommitmentQueue, DbContractStore, DbDamlPackageStore, DbInFlightSubmissionStore, DbIncrementalCommitmentStore, DbParticipantPruningSchedulerStore, DbParticipantPruningStore, DbParticipantSettingsStore, DbReassignmentStore, DbRegisteredSynchronizersStore, DbRequestJournalStore, DbSubmissionTrackerStore, DbSynchronizerConnectionConfigStore, DbSynchronizerParameterStore, InMemoryContractStore, MutablePackageMetadataViewImpl, ReassignmentCache, CantonSyncService, ConnectedSynchronizer, ParticipantEventPublisher, SyncEphemeralState, SynchronizerMigration, SynchronizerRegistryHelpers, GrpcSynchronizerRegistry, LedgerServerPartyNotifier, PackageOpsImpl, ParticipantTopologyDispatcher, ResourceCloseable, ReplicaManager, DbLock, DbLockPostgres, DbLockedConnection, DbLockedConnectionPool, DbStorage, DbStorageMulti, DbStorageSingle, DbStore, MemoryStorage, Storage, HasPruningSchedulerStore, ConnectionX, GrpcConnectionX, GrpcInternalSequencerConnectionX, GrpcSequencerConnectionX, InternalSequencerConnectionX, SequencerAggregator, SequencerClientRecorder, SequencerConnectionX, SequencerConnectionXPool, SequencerConnectionXPoolImpl, SequencerSubscriptionPool, SequencerSubscriptionPoolImpl, AuthenticationTokenProvider, PeriodicAcknowledgements, ResilientSequencerSubscriberPekko, ResilientSequencerSubscription, RichSequencerClient, RichSequencerClientImpl, SendTracker, SequencedEventValidatorImpl, SequencerClient, SequencerClientImpl, SequencerClientImplPekko, SequencerSubscription, SequencersTransportState, SequencerChannelClient, SequencerChannelProtocolProcessor, ConsumesCancellableGrpcStreamObserver, GrpcSequencerClientAuth, GrpcSequencerClientTransport, GrpcSequencerClientTransportPekko, GrpcSequencerSubscription, SequencerClientTransport, SequencerClientTransportCommon, SequencerClientTransportPekko, ReplayingEventsSequencerClientTransport, ReplayingSequencerSubscription, ReplayingSendsSequencerClientTransport, ReplayingSendsSequencerClientTransportCommon, ReplayingSendsSequencerClientTransportImpl, ReplayingSendsSequencerClientTransportPekko, SequencedEventStore, SequencerCounterTrackerStore, DbCursorPreheadStore, DbIndexedStringStore, DbPruningSchedulerStore, DbSequencedEventStore, DbSequencerCounterTrackerStore, InMemorySequencedEventStore, InMemorySequencerCounterTrackerStore, BlockSequencerStateManager, BlockSequencerStateManagerBase, DbSequencerBlockStore, CommunityMediatorReplicaManager, EnterpriseMediatorReplicaManager, MediatorNodeBootstrap, MediatorPruningScheduler, MediatorReplicaManager, MediatorRuntime, DbMediatorSynchronizerConfigurationStore, BaseSequencer, CommunityDatabaseSequencerFactory, DatabaseSequencer, DatabaseSequencerFactory, DirectSequencerClientTransport, EnterpriseDatabaseSequencerFactory, HASequencerWriterStoreFactory, LocalSequencerStateEventSignaller, Sequencer, SequencerFactory, SequencerNodeBootstrap, SequencerReader, SequencerRuntime, SequencerWriter, BlockSequencer, BlockSequencerFactory, DriverBlockSequencerFactory, BftBlockOrderer, BftSequencerFactory, AvailabilityModule, DbAvailabilityStore, EpochState, IssConsensusModule, IssSegmentModule, PreIssConsensusModule, SegmentClosingBehaviour, DbEpochStore, StateTransferBehavior, MempoolModule, OutputModule, PekkoBlockSubscription, DbOutputMetadataStore, PruningModule, BftP2PNetworkIn, BftP2PNetworkOut, GrpcNetworking, DbP2PEndpointsStore, Module, P2PNetworkRef, Availability, Consensus, Mempool, Output, P2PNetworkIn, P2PNetworkOut, Pruning, PekkoP2PNetworkRef, DbSequencerStore, DbSequencerSynchronizerConfigurationStore, HASequencerWriterStore, MemberAuthenticationService, MemberAuthenticationServiceImpl, DbSequencerStateManagerStore, ReferenceSequencerDriver, DbReferenceBlockOrderingStore, GrpcSequencerService, ManagedSubscription, SubscriptionPool, EnterpriseSequencerRateLimitManager, TrafficPurchasedManager, DbTrafficConsumedStore, DbTrafficPurchasedStore, PeriodicAction, RemoteClock, SynchronizerTimeTracker, TimeAwaiter, AuthorizedTopologyManager, LocalTopologyManager, QueueBasedSynchronizerOutbox, StoreBasedSynchronizerOutbox, SynchronizerOutbox, SynchronizerOutboxDispatch, SynchronizerOutboxFactorySingleCreate, SynchronizerOutboxHandle, SynchronizerTopologyManager, TemporaryStoreRegistry, TemporaryTopologyManager, TopologyManager, StoreBasedSynchronizerTopologyClient, TopologyAwaiter, TopologyTransactionProcessor, DbInitializationStore, TopologyStore, DbPartyMetadataStore, DbTopologyStore, InMemoryTopologyStore, MessageRecorder, SimpleExecutionQueue, WatchdogService
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PerformUnlessClosing
  2. HasSynchronizeWithReaders
  3. OnShutdownRunner
  4. HasRunOnClosing
  5. HasUnlessClosing
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def closingTimeout: FiniteDuration
    Attributes
    protected
  2. abstract def logger: TracedLogger
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addReader(reader: String)(implicit traceContext: TraceContext): UnlessShutdown[ReaderHandle]

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

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

    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. def close(): Unit

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

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

    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunner
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. def isClosing: Boolean

    Check whether we're closing.

    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.

    Definition Classes
    OnShutdownRunner → HasUnlessClosing
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def keepTrackOfReaderCallStack: Boolean

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

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

    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosing → HasSynchronizeWithReaders
  15. def maxSleepMillis: Long

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

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

    Attributes
    protected
  16. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosing → HasSynchronizeWithReaders
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
  21. def onClosed(): Unit
    Attributes
    protected
  22. final def onFirstClose(): Unit

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

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

    Definition Classes
    PerformUnlessClosing → OnShutdownRunner
    Annotations
    @SuppressWarnings()
  23. def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Performs the task given by f unless a shutdown has been initiated.

    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.

    f

    The task to perform

    returns

    scala.None$ if a shutdown has been initiated. Otherwise the result of the task.

  24. def performUnlessClosingCheckedT[A, N, R](name: String, onClosing: => Checked[A, N, R])(etf: => CheckedT[Future, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[Future, A, N, R]
  25. def performUnlessClosingCheckedUST[A, N, R](name: String, onClosing: => Checked[A, N, R])(etf: => CheckedT[FutureUnlessShutdown, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[FutureUnlessShutdown, A, N, R]
  26. def performUnlessClosingEitherT[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, R]

    Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead.

    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.

    etf

    The task to perform

  27. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
  28. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
  29. def performUnlessClosingEitherUSFAsync[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(asyncResultToWaitForF: (R) => FutureUnlessShutdown[_])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]

    Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

    Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

    etf

    closing of this object will wait for all such spawned Futures to finish

    asyncResultToWaitForF

    closing of this object will wait also wait for all such asynchronous Futures to finish too

    returns

    the future spawned by etf

  30. def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Performs the Future given by f unless a shutdown has been initiated.

    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.

    f

    The task to perform

    returns

    The future completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if a shutdown has been initiated. Otherwise the result of the task wrapped in com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome.

  31. def performUnlessClosingOptionUSF[R](name: String)(otf: => OptionT[FutureUnlessShutdown, R])(implicit ec: ExecutionContext, traceContext: TraceContext): OptionT[FutureUnlessShutdown, R]
  32. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
  33. def performUnlessClosingUSFAsync[A](name: String)(f: => FutureUnlessShutdown[A])(asyncResultToWaitForF: (A) => FutureUnlessShutdown[_])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

    Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

    f

    closing of this object will wait for all such spawned Futures to finish

    asyncResultToWaitForF

    closing of this object will wait also wait for all such asynchronous Futures to finish too

    returns

    the future spawned by f

  34. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  35. def removeReader(handle: ReaderHandle): Unit

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

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

    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  36. def runOnClose(task: RunOnClosing): UnlessShutdown[LifeCycleRegistrationHandle]

    Schedules the given task to be run upon closing.

    Schedules the given task to be run upon closing.

    returns

    An com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome indicates that the task will have been run when the LifeCycleManager's closeAsync method completes or when AutoCloseable's close method returns, unless the returned LifeCycleRegistrationHandle was used to cancel the task or the task has been done beforehand. com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if the task is not run due to closing. This always happens if isClosing returns true.

    Definition Classes
    OnShutdownRunner → HasRunOnClosing
  37. def runOnOrAfterClose(task: RunOnClosing)(implicit traceContext: TraceContext): LifeCycleRegistrationHandle

    Register a task to run when closing is initiated, or run it immediately if closing is already ongoing.

    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.

    Definition Classes
    HasRunOnClosing
  38. final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit

    Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.

    Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.

    Definition Classes
    HasRunOnClosing
  39. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunner → HasRunOnClosing
  40. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosing → HasSynchronizeWithReaders
  41. def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. def toString(): String
    Definition Classes
    AnyRef → Any
  44. final def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]

    Runs the computation fa unless isClosing returns true.

    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.

    returns

    The result of fa or com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if isClosing is true

    Definition Classes
    HasUnlessClosing
    Annotations
    @inline()
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from HasSynchronizeWithReaders

Inherited from OnShutdownRunner

Inherited from HasRunOnClosing

Inherited from HasUnlessClosing

Inherited from AnyRef

Inherited from Any

Ungrouped