class SyncDomain extends NamedLogging with StartAndCloseable[Either[SyncDomainInitializationError, Unit]] with TransferSubmissionHandle with HealthComponent

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SyncDomain
  2. HealthComponent
  3. BaseHealthComponent
  4. HealthElement
  5. TransferSubmissionHandle
  6. StartAndCloseable
  7. FlagCloseableAsync
  8. FlagCloseable
  9. AutoCloseable
  10. NamedLogging
  11. AnyRef
  12. 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. case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
    Definition Classes
    FlagCloseable
  2. type HealthListener = (SyncDomain.this.type, State, TraceContext) => Unit
    Definition Classes
    HealthElement
  3. type State = ComponentHealthState

Value Members

  1. object ReaderState extends Serializable
    Definition Classes
    FlagCloseable
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def authorityOfInSnapshotApproximation(requestingAuthority: Set[LfPartyId])(implicit traceContext: TraceContext): Future[AuthorityOfResponse]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. 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()
  9. 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
  10. val closingState: ComponentHealthState
  11. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  12. def completeTransferIn(implicit tc: TraceContext): FutureUnlessShutdown[Unit]
  13. 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
    HealthComponent
  14. def degradationOccurred(error: CantonError)(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
    HealthComponent
  15. val domainId: DomainId
  16. val ephemeral: SyncDomainEphemeralState
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  20. def failureOccurred(error: String)(implicit tc: TraceContext): Unit

    Report that the component is now failed

    Report that the component is now failed

    Definition Classes
    HealthComponent
  21. def failureOccurred(error: CantonError)(implicit tc: TraceContext): Unit

    Report that the component is now failed

    Report that the component is now failed

    Definition Classes
    HealthComponent
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def getState: State

    Current state

    Current state

    Definition Classes
    BaseHealthComponentHealthElement
  24. def getTrafficControlState: Future[Option[MemberTrafficStatus]]
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. val initialHealthState: ComponentHealthState
    Definition Classes
    SyncDomainBaseHealthComponent
  27. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  28. 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
    FlagCloseable
  29. def isFailed: Boolean
    Definition Classes
    BaseHealthComponent
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def isStarted: Boolean
    Definition Classes
    StartAndCloseable
  32. 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
    FlagCloseable
  33. val listeners: AtomicReference[List[HealthListener]]
    Attributes
    protected
    Definition Classes
    HealthElement
  34. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  35. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    SyncDomainNamedLogging
  36. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  37. val name: String

    Name of the health element.

    Name of the health element. Used for logging.

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

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

  56. def readyForSubmission: Boolean
  57. def registerOnHealthChange(listener: HealthListener): Unit
    Definition Classes
    BaseHealthComponentHealthElement
  58. def reportHealthState(state: State)(implicit tc: TraceContext): Boolean
    Definition Classes
    BaseHealthComponent
  59. def reportHealthState_(state: State)(implicit tc: TraceContext): Unit
    Definition Classes
    BaseHealthComponent
  60. def resolveUnhealthy(implicit traceContext: TraceContext): Boolean

    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
    HealthComponent
  61. def resolveUnhealthy_(implicit traceContext: TraceContext): Unit
    Definition Classes
    HealthComponent
  62. 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
    FlagCloseable
  63. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  64. 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
  65. def startAsync()(implicit initializationTraceContext: TraceContext): Future[Either[SyncDomainInitializationError, Unit]]
    Attributes
    protected
    Definition Classes
    SyncDomainStartAndCloseable
  66. lazy val stateRef: AtomicReference[State]
    Attributes
    protected
    Definition Classes
    BaseHealthComponent
  67. val staticDomainParameters: StaticDomainParameters
  68. 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.

  69. def submitTransferIn(submitterMetadata: TransferSubmitterMetadata, transferId: TransferId, sourceProtocolVersion: SourceProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, TransferProcessorError, FutureUnlessShutdown[SubmissionResult]]
    Definition Classes
    SyncDomainTransferSubmissionHandle
  70. def submitTransferOut(submitterMetadata: TransferSubmitterMetadata, contractId: LfContractId, targetDomain: TargetDomainId, targetProtocolVersion: TargetProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, TransferProcessorError, FutureUnlessShutdown[SubmissionResult]]
    Definition Classes
    SyncDomainTransferSubmissionHandle
  71. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  72. val timeTracker: DomainTimeTracker
    Definition Classes
    SyncDomainTransferSubmissionHandle
  73. def timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    SyncDomainFlagCloseable
  74. def toComponentStatus: ComponentStatus
    Definition Classes
    BaseHealthComponent
  75. def toString(): String
    Definition Classes
    SyncDomain → AnyRef → Any
  76. val topologyClient: DomainTopologyClientWithInit
  77. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  78. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  79. 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

Inherited from HealthComponent

Inherited from BaseHealthComponent

Inherited from HealthElement

Inherited from FlagCloseableAsync

Inherited from FlagCloseable

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped