trait OnShutdownRunner extends HasRunOnClosing

Self Type
OnShutdownRunner with AutoCloseable
Linear Supertypes
HasRunOnClosing, HasUnlessClosing, AnyRef, Any
Known Subclasses
AcsCommitmentBenchmarkCaching, AcsCommitmentBenchmarkContractTypes, RegisterTopologyTransactionHandle, SequencerBasedRegisterTopologyTransactionHandle, GrpcSequencerConnectClient, ExecutionContextMonitor, ConsoleEnvironment, GrpcAdminCommandRunner, 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, PureOnShutdownRunner, PerformUnlessClosing, SequencerBenchmark, StorageWithDedicatedDatabase, GrpcManagedChannel, 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. OnShutdownRunner
  2. HasRunOnClosing
  3. HasUnlessClosing
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def logger: TracedLogger
    Attributes
    protected
  2. abstract def onFirstClose(): Unit
    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]) @IntrinsicCandidate() @native()
  6. 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]
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. 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
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. 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
  17. 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
  18. 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
  19. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunner → HasRunOnClosing
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. 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()
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. 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

    (Since version 9)

Inherited from HasRunOnClosing

Inherited from HasUnlessClosing

Inherited from AnyRef

Inherited from Any

Ungrouped