class SyncDomain extends NamedLogging with StartAndCloseable[Either[SyncDomainInitializationError, Unit]] with TransferSubmissionHandle with CloseableHealthComponent with AtomicHealthComponent with HasCloseContext

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SyncDomain
  2. HasCloseContext
  3. PromiseUnlessShutdownFactory
  4. AtomicHealthComponent
  5. AtomicHealthElement
  6. CloseableHealthComponent
  7. HealthComponent
  8. CloseableHealthQuasiComponent
  9. HealthQuasiComponent
  10. CloseableHealthElement
  11. HealthElement
  12. TransferSubmissionHandle
  13. StartAndCloseable
  14. FlagCloseableAsync
  15. FlagCloseable
  16. PerformUnlessClosing
  17. OnShutdownRunner
  18. AutoCloseable
  19. NamedLogging
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SyncDomain(domainId: DomainId, domainHandle: DomainHandle, participantId: ParticipantId, engine: Engine, authorityResolver: AuthorityResolver, parameters: ParticipantNodeParameters, participantNodePersistentState: Eval[ParticipantNodePersistentState], persistent: SyncDomainPersistentState, ephemeral: SyncDomainEphemeralState, packageService: PackageService, domainCrypto: DomainSyncCryptoClient, identityPusher: ParticipantTopologyDispatcherCommon, topologyProcessorFactory: Factory, missingKeysAlerter: MissingKeysAlerter, transferCoordination: TransferCoordination, inFlightSubmissionTracker: InFlightSubmissionTracker, messageDispatcherFactory: Factory[MessageDispatcher], clock: Clock, pruningMetrics: PruningMetrics, metrics: SyncDomainMetrics, trafficStateController: TrafficStateController, futureSupervisor: FutureSupervisor, loggerFactory: NamedLoggerFactory, skipRecipientsCheck: Boolean)(implicit ec: ExecutionContext, tracer: Tracer)

    domainId

    The identifier of the connected domain.

    domainHandle

    A domain handle providing sequencer clients.

    participantId

    The participant node id hosting this sync service.

    persistent

    The persistent state of the sync domain.

    ephemeral

    The ephemeral state of the sync domain.

    packageService

    Underlying package management service.

    domainCrypto

    Synchronisation crypto utility combining IPS and Crypto operations for a single domain.

Type Members

  1. type State = ComponentHealthState

    The type of health states exposed by this component

    The type of health states exposed by this component

    Definition Classes
    HealthComponentHealthQuasiComponentHealthElement

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 addJournalGarageCollectionLock()(implicit traceContext: TraceContext): Future[Unit]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. final def associatedOnShutdownRunner: FlagCloseable

    The com.digitalasset.canton.lifecycle.OnShutdownRunner associated with this object.

    The com.digitalasset.canton.lifecycle.OnShutdownRunner associated with this object.

    When this com.digitalasset.canton.lifecycle.OnShutdownRunner closes, the health state permanently becomes closingState and all listeners are notified about this.

    Attributes
    protected
    Definition Classes
    CloseableHealthElementHealthElement
  7. def authorityOfInSnapshotApproximation(requestingAuthority: Set[LfPartyId])(implicit traceContext: TraceContext): Future[AuthorityOfResponse]
  8. 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
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. 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
    FlagCloseableOnShutdownRunner → AutoCloseable
  11. def closeAsync(): Seq[AsyncOrSyncCloseable]

    closeAsync asynchronously releases resources held by a future

    closeAsync asynchronously releases resources held by a future

    returns

    an ordered sequence of async and sync closeables with async closeables made up of future and timeout

    Attributes
    protected
    Definition Classes
    SyncDomainFlagCloseableAsync
  12. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  13. def closingState: ComponentHealthState

    The state set when the associatedOnShutdownRunner closes

    The state set when the associatedOnShutdownRunner closes

    Definition Classes
    SyncDomainHealthComponentHealthQuasiComponentHealthElement
  14. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  15. def completeTransferIn(implicit tc: TraceContext): FutureUnlessShutdown[Unit]
  16. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  17. def degradationOccurred(error: String)(implicit tc: TraceContext): Unit

    Report that the component is now degraded.

    Report that the component is now degraded. Note that this will override the component state, even if it is currently failed!

    Definition Classes
    AtomicHealthComponent
  18. def degradationOccurred(error: BaseError)(implicit tc: TraceContext): Unit

    Report that the component is now degraded.

    Report that the component is now degraded. Note that this will override the component state, even if it is currently failed!

    Definition Classes
    AtomicHealthComponent
  19. val domainId: DomainId
  20. val ephemeral: SyncDomainEphemeralState
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  23. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  24. def failureOccurred(error: String)(implicit tc: TraceContext): Unit

    Report that the component is now failed

    Report that the component is now failed

    Definition Classes
    AtomicHealthComponent
  25. def failureOccurred(error: BaseError)(implicit tc: TraceContext): Unit

    Report that the component is now failed

    Report that the component is now failed

    Definition Classes
    AtomicHealthComponent
  26. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def getState: State

    Returns the current state

    Returns the current state

    Definition Classes
    HealthElement
  28. def getTrafficControlState(implicit tc: TraceContext): Future[Option[MemberTrafficStatus]]
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. def initialHealthState: ComponentHealthState

    The initial state upon creation

    The initial state upon creation

    Definition Classes
    SyncDomainHealthElement
  31. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  32. 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.

    Definition Classes
    OnShutdownRunner
  33. def isFailed: Boolean
    Definition Classes
    HealthQuasiComponent
  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. def isStarted: Boolean
    Definition Classes
    StartAndCloseable
  36. 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
  37. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  38. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    SyncDomainNamedLogging
  39. 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
  40. def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext, ec: ExecutionContext): PromiseUnlessShutdown[A]

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed.

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed. This allows proper clean up of stray promises when the node is transitioning to a passive state.

    Note: you should *not* invoke success on the returned promise but rather use trySuccess. The reason is that the call to success may fail in case of shutdown.

    Definition Classes
    PromiseUnlessShutdownFactory
  41. val name: String

    Name of the health element.

    Name of the health element. Used for logging.

    Definition Classes
    SyncDomainHealthElement
  42. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  43. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  44. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  45. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  46. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  47. def numberOfDirtyRequests(): Int
  48. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  49. final def onClosed(): Unit
  50. 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
    PerformUnlessClosingOnShutdownRunner
    Annotations
    @SuppressWarnings()
  51. val packageService: PackageService
  52. 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
  53. 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
  54. 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
  55. 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
  56. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  57. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  58. 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
  59. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  60. def prettyState: Pretty[State]
    Attributes
    protected
    Definition Classes
    HealthQuasiComponentHealthElement
  61. def ready: Boolean

    A SyncDomain is ready when it has resubscribed to the sequencer client.

  62. def readyForSubmission: Boolean
  63. def refreshState(newState: Eval[State])(implicit traceContext: TraceContext): Unit

    Triggers a refresh of the component's state, using newState to determine the new state.

    Triggers a refresh of the component's state, using newState to determine the new state. May return before the newState has been evaluated and the listeners have been poked.

    Note that listeners need not be poked about every state change; it suffices that they are poked eventually after each state change. So if there are frequent updates to the state, possibly from concurrent calls, then the listeners may never see some intermediate states.

    Attributes
    protected
    Definition Classes
    HealthElement
  64. def registerOnHealthChange(listener: HealthListener): Boolean

    Registers a listener that gets poked upon each change of this element's health state.

    Registers a listener that gets poked upon each change of this element's health state.

    returns

    Whether the listener was not registered before

    Definition Classes
    HealthElement
  65. def removeJournalGarageCollectionLock()(implicit traceContext: TraceContext): Unit
  66. def reportHealthState(state: State)(implicit tc: TraceContext): Unit

    Sets the state of this component and notifies its listeners

    Sets the state of this component and notifies its listeners

    Definition Classes
    AtomicHealthElement
  67. def resolveUnhealthy()(implicit traceContext: TraceContext): Unit

    Set the health state to Ok and if the previous state was unhealthy, log a message to inform about the resolution of the ongoing issue.

    Set the health state to Ok and if the previous state was unhealthy, log a message to inform about the resolution of the ongoing issue.

    Definition Classes
    AtomicHealthComponent
  68. 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
  69. 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
  70. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  71. final def start()(implicit ec: ExecutionContext, traceContext: TraceContext): Future[Either[SyncDomainInitializationError, Unit]]

    Start the process

    Start the process

    The method is idempotent. It will not execute start twice. It will also not start the process if close() has already been called. In that case, the returned future fails with com.digitalasset.canton.lifecycle.StartAndCloseable.StartAfterClose. If close is called concurrently, it will delay the close until the start has succeeded.

    Definition Classes
    StartAndCloseable
  72. def startAsync()(implicit initializationTraceContext: TraceContext): Future[Either[SyncDomainInitializationError, Unit]]
    Attributes
    protected
    Definition Classes
    SyncDomainStartAndCloseable
  73. val staticDomainParameters: StaticDomainParameters
  74. def submitTransaction(submitterInfo: SubmitterInfo, transactionMeta: TransactionMeta, keyResolver: LfKeyResolver, transaction: WellFormedTransaction[WithoutSuffixes], disclosedContracts: Map[LfContractId, SerializableContract])(implicit traceContext: TraceContext): EitherT[Future, TransactionSubmissionError, FutureUnlessShutdown[TransactionSubmitted]]

    returns

    The outer future completes after the submission has been registered as in-flight. The inner future completes after the submission has been sequenced or if it will never be sequenced.

  75. def submitTransferIn(submitterMetadata: TransferSubmitterMetadata, transferId: TransferId, sourceProtocolVersion: SourceProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, TransferProcessorError, FutureUnlessShutdown[SubmissionResult]]
    Definition Classes
    SyncDomainTransferSubmissionHandle
  76. def submitTransferOut(submitterMetadata: TransferSubmitterMetadata, contractId: LfContractId, targetDomain: TargetDomainId, targetProtocolVersion: TargetProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, TransferProcessorError, FutureUnlessShutdown[SubmissionResult]]
    Definition Classes
    SyncDomainTransferSubmissionHandle
  77. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  78. val timeTracker: DomainTimeTracker
    Definition Classes
    SyncDomainTransferSubmissionHandle
  79. def timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    SyncDomainFlagCloseable
  80. def toComponentStatus: ComponentStatus
    Definition Classes
    HealthQuasiComponent
  81. def toString(): String
    Definition Classes
    SyncDomain → AnyRef → Any
  82. val topologyClient: DomainTopologyClientWithInit
  83. def unregisterOnHealthChange(listener: HealthListener): Boolean

    Unregisters a listener.

    Unregisters a listener.

    returns

    Whether the listener was registered before.

    Definition Classes
    HealthElement
  84. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  85. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  86. 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 HasCloseContext

Inherited from AtomicHealthComponent

Inherited from AtomicHealthElement

Inherited from HealthComponent

Inherited from HealthQuasiComponent

Inherited from CloseableHealthElement

Inherited from HealthElement

Inherited from FlagCloseableAsync

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped