class SyncDomain extends NamedLogging with StartAndCloseable[Either[SyncDomainInitializationError, Unit]] with TransferSubmissionHandle with HasDegradationState[CantonError]
A connected domain from the synchronization service.
- Alphabetic
- By Inheritance
- SyncDomain
- HasDegradationState
- TransferSubmissionHandle
- StartAndCloseable
- FlagCloseableAsync
- FlagCloseable
- AutoCloseable
- NamedLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
- case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
- Definition Classes
- FlagCloseable
Value Members
- object ReaderState extends Serializable
- Definition Classes
- FlagCloseable
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- 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()
- 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
- SyncDomain → FlagCloseableAsync
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def completeTxIn(implicit tc: TraceContext): Future[Unit]
- 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
- val degradationState: AtomicReference[Option[CantonError]]
- Attributes
- protected
- Definition Classes
- HasDegradationState
- val domainId: DomainId
- val ephemeral: SyncDomainEphemeralState
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getDegradationState: Option[CantonError]
- Definition Classes
- HasDegradationState
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- FlagCloseable
- 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
- def isDegraded: Boolean
- Definition Classes
- HasDegradationState
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isStarted: Boolean
- Definition Classes
- StartAndCloseable
- 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
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- SyncDomain → NamedLogging
- def maxSleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def numberOfDirtyRequests(): Int
- final def onClosed(): Unit
- Definition Classes
- FlagCloseableAsync → FlagCloseable
- val packageService: PackageService
- def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Performs the task given by
funless a shutdown has been initiated.Performs the task given by
funless a shutdown has been initiated. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, 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.closeas part off, 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
- 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
etfunless a shutdown has been initiated, in which case the provided error is returned instead.Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead. Bothetfand the error are lazy;etfis only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin afteretfcompletes, but other tasks may execute concurrently withetf, 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.closeas part ofetf, because it will result in a deadlock.- etf
The task to perform
- Definition Classes
- FlagCloseable
- 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
- def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- FlagCloseable
- def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Performs the Future given by
funless a shutdown has been initiated.Performs the Future given by
funless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, 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.closeas part off, 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
- def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
- Definition Classes
- FlagCloseable
- def ready: Boolean
A SyncDomain is ready when it has resubscribed to the sequencer client.
- def readyForSubmission: Boolean
- def resolveDegradationIfExists(message: (CantonError) => String): Unit
- Definition Classes
- HasDegradationState
- 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
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- Annotations
- @VisibleForTesting()
- 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
- def startAsync(): Future[Either[SyncDomainInitializationError, Unit]]
- Attributes
- protected
- Definition Classes
- SyncDomain → StartAndCloseable
- val staticDomainParameters: StaticDomainParameters
- 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.
- def submitTransferIn(submittingParty: LfPartyId, transferId: TransferId, sourceProtocolVersion: SourceProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, TransferProcessorError, SubmissionResult]
- Definition Classes
- SyncDomain → TransferSubmissionHandle
- def submitTransferOut(submittingParty: LfPartyId, contractId: LfContractId, targetDomain: DomainId, targetProtocolVersion: TargetProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, TransferProcessorError, SubmissionResult]
- Definition Classes
- SyncDomain → TransferSubmissionHandle
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeTracker: DomainTimeTracker
- Definition Classes
- SyncDomain → TransferSubmissionHandle
- def timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- SyncDomain → FlagCloseable
- def toString(): String
- Definition Classes
- SyncDomain → AnyRef → Any
- val topologyClient: DomainTopologyClientWithInit
- val topologyProcessor: TopologyTransactionProcessor
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])