trait FlagCloseable extends AutoCloseable with PerformUnlessClosing

Adds the java.lang.AutoCloseable.close method to the interface of PerformUnlessClosing. The component's custom shutdown behaviour should override the onClosed method.

Linear Supertypes
PerformUnlessClosing, OnShutdownRunner, AutoCloseable, AnyRef, Any
Known Subclasses
DomainTopologyService, RegisterTopologyTransactionHandleCommon, RegisterTopologyTransactionHandleWithProcessor, SequencerBasedRegisterTopologyTransactionHandle, GrpcSequencerConnectClient, ExecutionContextMonitor, ConsoleEnvironment, EnterpriseConsoleEnvironment, Crypto, CryptoPrivateApi, CryptoPrivateStoreApi, DomainSyncCryptoClient, Kms, SymbolicKms, AwsKms, DriverKms, GcpKms, JcePrivateCrypto, AwsKmsPrivateCrypto, DriverKmsPrivateCrypto, GcpKmsPrivateCrypto, KmsPrivateCrypto, TinkPrivateCrypto, DbKmsMetadataStore, EncryptedCryptoPrivateStore, DbCryptoPrivateStore, DbCryptoPublicStore, TaskScheduler, DemoRunner, DomainNodeBootstrap, BlockSequencerStateManager, BlockSequencerStateManagerBase, DbSequencerBlockStore, DbDomainNodeSettingsStore, TopologyManagementComponents, DomainManagerBootstrap, DomainManagerReplicaManager, DomainManagerRuntime, DbDomainManagerNodeSettingsStore, EnterpriseMediatorRuntime, MediatorNodeBootstrap, MediatorPruningScheduler, MediatorReplicaManager, MediatorRuntime, DbMediatorDomainConfigurationStore, MediatorTopologyManager, HASequencerWriterStoreFactory, SequencerNodeBootstrap, SequencerRuntime, SequencerRuntimeForSeparateNode, SequencerAdminClient, DbMemberAuthenticationStore, MemberAuthenticationService, MemberAuthenticationServiceOld, DbSequencerStateManagerStore, BaseSequencer, DatabaseSequencer, DirectSequencerClientTransport, LocalSequencerStateEventSignaller, Sequencer, SequencerReader, SequencerWriter, BlockSequencer, DbReferenceBlockOrderingStore, DbSequencerDomainConfigurationStore, DbSequencerStore, HASequencerWriterStore, GrpcSequencerService, ManagedSubscription, SubscriptionPool, SequencerTopologyManager, DbServiceAgreementAcceptanceStore, DomainTopologyManager, DomainTopologyManagerEventHandler, DomainTopologySender, Impl, DbRegisterTopologyTransactionResponseStore, BootstrapStage, BootstrapStageOrLeaf, BootstrapStageWithStorage, CantonNodeBootstrap, CantonNodeBootstrapBase, InitializationWatcher, CommunityConsoleEnvironment, DomainManagerNodes, DomainNodes, ManagedNodes, MediatorNodes, Nodes, ParticipantNodes, RunningNode, SequencerNodes, CloseableAtomicHealthComponent, CloseableHealthComponent, CloseableHealthElement, CloseableHealthQuasiComponent, DelegatingMutableHealthComponent, DelegatingMutableHealthQuasiComponent, DependenciesHealthService, GrpcHealthServer, HealthServer, HealthService, LivenessHealthService, MutableHealthComponent, MutableHealthQuasiComponent, FlagCloseableAsync, StartAndCloseable, SequencerBenchmark, StorageWithDedicatedDatabase, ParticipantNodeBootstrap, AdminWorkflowServices, PackageDependencyResolver, PackageService, PackageUploader, PingService, RepairService, AgreementService, DomainRegistryHelpers, GrpcDomainRegistry, RecordOrderPublisher, LedgerApiServerState, StartableStoppableLedgerApiServer, CommandSubmitterWithRetry, LedgerAcs, LedgerConnection, LedgerSubmit, LedgerSubscription, AbstractMessageProcessor, BadRootHashMessagesRequestProcessor, Phase37Synchronizer, ProtocolProcessor, SubmissionTrackerImpl, TransactionProcessor, InFlightSubmissionTracker, DomainRouter, TransferInProcessor, TransferOutProcessor, AcsCommitmentProcessor, ParticipantPruningSchedulerImpl, PruningProcessorImpl, ParticipantReplicaManager, ParticipantNodePersistentState, SyncDomainEphemeralState, DbAcsCommitmentStore, DbActiveContractStore, DbCommandDeduplicationStore, DbCommitmentQueue, DbContractKeyJournal, DbContractStore, DbDamlPackageStore, DbDomainConnectionConfigStore, DbDomainParameterStore, DbInFlightSubmissionStore, DbIncrementalCommitmentStore, DbMultiDomainEventLog, DbParticipantEventLog, DbParticipantPruningSchedulerStore, DbParticipantPruningStore, DbParticipantSettingsStore, DbRegisteredDomainsStore, DbRequestJournalStore, DbServiceAgreementStore, DbSingleDimensionEventLog, DbSubmissionTrackerStore, DbTransferStore, InMemoryMultiDomainEventLog, CantonSyncService, ParticipantEventPublisher, SyncDomain, SyncDomainMigration, LedgerServerPartyNotifier, ParticipantTopologyDispatcher, ParticipantTopologyDispatcherCommon, ParticipantTopologyDispatcherImplCommon, ParticipantTopologyManager, TopologyDispatcherCommon, ReplicaManager, DbLock, DbLockOracle, DbLockPostgres, DbLockedConnection, DbLockedConnectionPool, DbStorage, DbStorageMulti, DbStorageSingle, DbStore, MemoryStorage, Storage, HasPruningSchedulerStore, SequencerAggregator, SequencerClientRecorder, AuthenticationTokenProvider, PeriodicAcknowledgements, ResilientSequencerSubscriberPekko, ResilientSequencerSubscription, SendTracker, SequencedEventValidatorImpl, SequencerClient, SequencerClientImpl, SequencerSubscription, SequencersTransportState, GrpcSequencerClientAuth, GrpcSequencerClientTransport, GrpcSequencerClientTransportPekko, GrpcSequencerSubscription, SequencerClientTransport, SequencerClientTransportCommon, SequencerClientTransportPekko, ReplayingEventsSequencerClientTransport, ReplayingSequencerSubscription, ReplayingSendsSequencerClientTransport, ReplayingSendsSequencerClientTransportCommon, ReplayingSendsSequencerClientTransportImpl, ReplayingSendsSequencerClientTransportPekko, SequencerHandshake, SequencerCounterTrackerStore, DbCursorPreheadStore, DbIndexedStringStore, DbPruningSchedulerStore, DbSendTrackerStore_Unused, DbSequencedEventStore, DbSequencerCounterTrackerStore, InMemorySequencerCounterTrackerStore, DomainTimeTracker, PeriodicAction, DomainOutboxCommon, DomainOutboxDispatch, DomainOutboxHandle, StoreBasedDomainOutbox, StoreBasedDomainOutboxCommon, TopologyManager, BaseDomainTopologyClient, BaseDomainTopologyClientOld, StoreBasedDomainTopologyClient, TopologyAwaiter, SnapshotAuthorizationValidator, TopologyTimestampPlusEpsilonTracker, TopologyTransactionProcessor, TopologyTransactionProcessorCommon, TopologyTransactionProcessorCommonImpl, DbInitializationStore, TopologyStore, TopologyStoreCommon, DbPartyMetadataStore, DbTopologyStore, InMemoryTopologyStore, MessageRecorder, SimpleExecutionQueue, WatchdogService
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FlagCloseable
  2. PerformUnlessClosing
  3. OnShutdownRunner
  4. AutoCloseable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
  2. abstract def timeouts: ProcessingTimeout
    Attributes
    protected

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def cancelShutdownTask(token: Long): Unit

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

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

    Definition Classes
    OnShutdownRunner
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. final 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.

    Definition Classes
    FlagCloseable → OnShutdownRunner → AutoCloseable
  8. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable → PerformUnlessClosing
  9. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  15. 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
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def keepTrackOfOpenFutures: Boolean

    track running futures on shutdown

    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.

    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  18. 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
    Definition Classes
    PerformUnlessClosing
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  22. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  23. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  24. 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()
  25. 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.

    f

    The task to perform

    returns

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

    Definition Classes
    PerformUnlessClosing
  26. 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]
    Definition Classes
    PerformUnlessClosing
  27. 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.

    etf

    The task to perform

    Definition Classes
    PerformUnlessClosing
  28. def performUnlessClosingEitherTF[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
    Definition Classes
    PerformUnlessClosing
  29. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  30. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  31. 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.

    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.

    Definition Classes
    PerformUnlessClosing
  32. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  33. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Long

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

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

    Definition Classes
    OnShutdownRunner
  34. def runOnShutdown_[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit

    Register a task to run when shutdown is initiated.

    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".

    Definition Classes
    OnShutdownRunner
  35. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  36. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  37. def toString(): String
    Definition Classes
    AnyRef → Any
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped