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

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SyncDomain
  2. HasDegradationState
  3. TransferSubmissionHandle
  4. StartAndCloseable
  5. FlagCloseableAsync
  6. FlagCloseable
  7. AutoCloseable
  8. NamedLogging
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SyncDomain(domainId: DomainId, domainHandle: DomainHandle, participantId: ParticipantId, damle: DAMLe, parameters: ParticipantNodeParameters, participantNodePersistentState: ParticipantNodePersistentState, persistent: SyncDomainPersistentState, ephemeral: SyncDomainEphemeralState, packageService: PackageService, domainCrypto: DomainSyncCryptoClient, partyNotifier: LedgerServerPartyNotifier, topologyClient: DomainTopologyClientWithInit, identityPusher: ParticipantTopologyDispatcher, transferCoordination: TransferCoordination, inFlightSubmissionTracker: InFlightSubmissionTracker, messageDispatcherFactory: Factory[MessageDispatcher], clock: Clock, selfKillSwitch: => Unit, pruningMetrics: PruningMetrics, metrics: SyncDomainMetrics, futureSupervisor: FutureSupervisor, loggerFactory: NamedLoggerFactory)(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

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  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 → AutoCloseable
    Annotations
    @SuppressWarnings()
  8. 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
  9. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  10. def completeTxIn(implicit tc: TraceContext): Future[Unit]
  11. def degradationOccurred(error: CantonError): Unit

    Track that the given error has occurred for the specified key

    Track that the given error has occurred for the specified key

    Definition Classes
    HasDegradationState
  12. val degradationState: AtomicReference[Option[CantonError]]
    Attributes
    protected
    Definition Classes
    HasDegradationState
  13. val domainId: DomainId
  14. val ephemeral: SyncDomainEphemeralState
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def getDegradationState: Option[CantonError]
    Definition Classes
    HasDegradationState
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  22. 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
  23. def isDegraded: Boolean
    Definition Classes
    HasDegradationState
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def isStarted: Boolean
    Definition Classes
    StartAndCloseable
  26. 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
  27. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  28. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    SyncDomainNamedLogging
  29. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  30. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. def numberOfDirtyRequests(): Int
  36. final def onClosed(): Unit
    Definition Classes
    FlagCloseableAsyncFlagCloseable
  37. val packageService: PackageService
  38. 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
  39. 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
  40. 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
  41. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  42. 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
  43. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    FlagCloseable
  44. def ready: Boolean

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

  45. def readyForSubmission: Boolean
  46. def resolveDegradationIfExists(message: (CantonError) => String): Unit
    Definition Classes
    HasDegradationState
  47. 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
  48. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  49. 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
  50. def startAsync(): Future[Either[SyncDomainInitializationError, Unit]]
    Attributes
    protected
    Definition Classes
    SyncDomainStartAndCloseable
  51. val staticDomainParameters: StaticDomainParameters
  52. def submitTransaction(submitterInfo: SubmitterInfo, transactionMeta: TransactionMeta, keyResolver: LfKeyResolver, transaction: WellFormedTransaction[WithoutSuffixes])(implicit traceContext: TraceContext): EitherT[Future, TransactionSubmissionError, Future[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.

  53. def submitTransferIn(submittingParty: LfPartyId, transferId: TransferId, sourceProtocolVersion: SourceProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, TransferProcessorError, SubmissionResult]
    Definition Classes
    SyncDomainTransferSubmissionHandle
  54. def submitTransferOut(submittingParty: LfPartyId, contractId: LfContractId, targetDomain: DomainId, targetProtocolVersion: TargetProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, TransferProcessorError, SubmissionResult]
    Definition Classes
    SyncDomainTransferSubmissionHandle
  55. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  56. val timeTracker: DomainTimeTracker
    Definition Classes
    SyncDomainTransferSubmissionHandle
  57. def timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    SyncDomainFlagCloseable
  58. def toString(): String
    Definition Classes
    SyncDomain → AnyRef → Any
  59. val topologyClient: DomainTopologyClientWithInit
  60. val topologyProcessor: TopologyTransactionProcessor
  61. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  62. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  63. 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 FlagCloseableAsync

Inherited from FlagCloseable

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped