trait FlagCloseable extends AutoCloseable

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.

The component's custom shutdown behaviour should override the onClosed method.

Linear Supertypes
AutoCloseable, AnyRef, Any
Known Subclasses
ExecutionContextMonitor, ConsoleEnvironment, EnterpriseConsoleEnvironment, Crypto, DomainSyncCryptoClient, EncryptedCryptoPrivateStore, DbCryptoPrivateStore, DbCryptoPublicStore, TaskScheduler, DemoRunner, DomainNodeBootstrap, BlockSequencerStateManager, DbSequencerBlockStore, DbDomainNodeSettingsStore, TopologyManagementComponents, DomainManagerBootstrap, DomainManagerReplicaManager, DomainManagerRuntime, DbDomainManagerNodeSettingsStore, EnterpriseMediatorRuntime, MediatorNodeBootstrap, MediatorPruningScheduler, MediatorReplicaManager, MediatorRuntime, DbMediatorDomainConfigurationStore, MediatorTopologyManager, HASequencerWriterStoreFactory, SequencerNodeBootstrap, SequencerRuntime, SequencerAdminClient, DbMemberAuthenticationStore, MemberAuthenticationService, DbSequencerStateManagerStore, BaseSequencer, DatabaseSequencer, DirectSequencerClientTransport, LocalSequencerStateEventSignaller, Sequencer, SequencerReader, SequencerWriter, BlockSequencer, DbSequencerDomainConfigurationStore, DbSequencerStore, HASequencerWriterStore, GrpcSequencerService, ManagedSubscription, SubscriptionPool, DbServiceAgreementAcceptanceStore, DomainTopologyManager, DomainTopologyManagerEventHandler, Impl, DbRegisterTopologyTransactionResponseStore, CantonNodeBootstrap, CantonNodeBootstrapBase, CommunityConsoleEnvironment, DomainManagerNodes, DomainNodes, ManagedNodes, MediatorNodes, Nodes, ParticipantNodes, SequencerNodes, BackgroundRunner, GrpcHealthServer, HealthServer, FlagCloseableAsync, StartAndCloseable, SequencerBenchmark, ParticipantNodeBootstrap, AdminWorkflowServices, PackageService, PingService, RepairService, AgreementService, DomainRegistryHelpers, SequencerBasedRegisterTopologyTransactionHandle, GrpcDomainRegistry, GrpcSequencerConnectClient, RecordOrderPublisher, LedgerApiServerState, StartableStoppableLedgerApiServer, CommandSubmitterWithRetry, LedgerAcs, LedgerConnection, LedgerSubmit, LedgerSubscription, AbstractMessageProcessor, BadRootHashMessagesRequestProcessor, ProtocolProcessor, TransactionProcessor, InFlightSubmissionTracker, DomainRouter, TransferInProcessor, TransferOutProcessor, AcsCommitmentProcessor, ParticipantPruningScheduler, PruningProcessorImpl, ParticipantReplicaManager, ParticipantNodePersistentState, DbAcsCommitmentStore, DbActiveContractStore, DbCommandDeduplicationStore, DbCommitmentQueue, DbContractKeyJournal, DbContractStore, DbDamlPackageStore, DbDomainConnectionConfigStore, DbDomainParameterStore, DbInFlightSubmissionStore, DbIncrementalCommitmentStore, DbMultiDomainCausalityStore, DbMultiDomainEventLog, DbParticipantEventLog, DbParticipantPruningStore, DbParticipantSettingsStore, DbRegisteredDomainsStore, DbRequestJournalStore, DbServiceAgreementStore, DbSingleDimensionEventLog, DbSingleDomainCausalDependencyStore, DbTransferStore, InMemoryMultiDomainEventLog, CantonSyncService, ParticipantEventPublisher, SyncDomain, SyncDomainMigration, LedgerServerPartyNotifier, ParticipantTopologyDispatcher, ParticipantTopologyManager, RegisterTopologyTransactionHandle, ReplicaManager, DbLock, DbLockOracle, DbLockPostgres, DbLockedConnection, DbLockedConnectionPool, DbStorage, DbStorageMulti, DbStorageSingle, DbStore, HasPruningSchedulerStore, SequencerClientRecorder, AuthenticationTokenProvider, PeriodicAcknowledgements, ResilientSequencerSubscription, SendTracker, SequencedEventValidator, SequencedEventValidatorImpl, SequencerClient, SequencerSubscription, GrpcSequencerClientAuth, GrpcSequencerClientTransport, GrpcSequencerSubscription, SequencerClientTransport, ReplayingEventsSequencerClientTransport, ReplayingSequencerSubscription, ReplayingSendsSequencerClientTransport, SequencerHandshake, SequencerCounterTrackerStore, DbCursorPreheadStore, DbIndexedStringStore, DbPruningSchedulerStore, DbSendTrackerStore_Unused, DbSequencedEventStore, DbSequencerCounterTrackerStore, InMemorySequencerCounterTrackerStore, DomainTimeTracker, PeriodicAction, TopologyManager, BaseDomainTopologyClient, StoreBasedDomainTopologyClient, TopologyAwaiter, TopologyTimestampPlusEpsilonTracker, TopologyTransactionProcessor, DbInitializationStore, DbPartyMetadataStore, DbTopologyStore, DbTopologyStoreFactory, MessageRecorder
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FlagCloseable
  2. AutoCloseable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable

Abstract Value Members

  1. abstract def logger: TracedLogger
    Attributes
    protected
  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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. 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 → AutoCloseable
    Annotations
    @SuppressWarnings()
  7. def closingTimeout: FiniteDuration
    Attributes
    protected
  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
    @native() @HotSpotIntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
  13. def isClosing: Boolean

    Check whether we're closing.

    Check whether we're closing. Susceptible to race conditions; unless you're using using this as a flag to the retry lib or you really know what you're doing, prefer performUnlessClosing and friends.

  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. 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
  16. def maxSleepMillis: Long
    Attributes
    protected
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def onClosed(): Unit
    Attributes
    protected
  21. 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.

  22. 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]
  23. 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

  24. def performUnlessClosingEitherTF[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
  25. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
  26. 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.

  27. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
  28. 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".

  29. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Annotations
    @VisibleForTesting()
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. object ReaderState extends Serializable

Deprecated Value Members

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

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped