com.digitalasset.canton.participant.protocol.conflictdetection
ConflictDetector
Companion object ConflictDetector
class ConflictDetector extends NamedLogging with FlagCloseable
The ConflictDetector stores the state of contracts activated or deactivated by in-flight requests in memory, and similarly for contract keys. Such states take precedence over the states stored in the ACS or the contract key journal, which are only updated when a request is finalized. A request is in flight from the call to ConflictDetector.registerActivenessSet until the corresponding call to ConflictDetector.finalizeRequest has written the updates to the ACS.
The ConflictDetector also checks that transfer-ins refer to active transfers and atomically completes them during finalization.
- Alphabetic
- By Inheritance
- ConflictDetector
- FlagCloseable
- AutoCloseable
- NamedLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ConflictDetector(acs: ActiveContractStore, contractKeyJournal: ContractKeyJournal, transferCache: TransferCache, loggerFactory: NamedLoggerFactory, checkedInvariant: Boolean, executionContext: ExecutionContext, timeouts: ProcessingTimeout)
- checkedInvariant
Defines whether all methods should check the class invariant when they are called. Invariant checking is slow. It should only be enabled for testing and debugging.
Value Members
- 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 checkActivenessAndLock(rc: RequestCounter)(implicit traceContext: TraceContext): Future[ActivenessResult]
Performs the pre-registered activeness check consisting of the following:
Performs the pre-registered activeness check consisting of the following:
- Perform the ActivenessChecks for contracts and keys in the ActivenessSet.
- Lock the contracts and keys according to the ActivenessSet
- Check that the transfer-ins from the ActivenessSet are active
Must not be called concurrently with itself or finalizeRequest.
- returns
The activeness result of the activeness check The future fails with IllegalConflictDetectionStateException in the following cases:
- The request has not registered the activeness check using registerActivenessSet or the future returned by registration has not yet completed.
- The request has already performed its activeness check.
- Invariant checks fail
- 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 closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalizeRequest(commitSet: CommitSet, toc: TimeOfChange)(implicit traceContext: TraceContext): Future[Future[Either[NonEmptyChain[RequestTrackerStoreError], Unit]]]
Updates the states for the in-flight request
toc.rc according to thecommitSet.Updates the states for the in-flight request
toc.rc according to thecommitSet. All states in the CommitSet must have been declared as ActivenessCheck.lock in the ActivenessSet.- Contracts in
commitSet.archivals are archived. - Contracts in
commitSet.creations are created. - Contracts in
commitSet.transferOuts are transferred away to the given target domain. - Contracts in
commitSet.transferIns become active with the given origin domain - Keys in
commitSet.keyUpdates are set to the given com.digitalasset.canton.participant.store.ContractKeyJournal.Status - All contracts and keys locked by the ActivenessSet are unlocked.
- Transfers in ActivenessSet.transferIds are completed if they are in
commitSet.transferIns.
and writes the updates from
commitSetto the com.digitalasset.canton.participant.store.ActiveContractStore and the com.digitalasset.canton.participant.store.ContractKeyJournal. If no exception is thrown, the request is no longer in flight.All changes are carried out even if the ActivenessResult was not successful.
Must not be called concurrently with checkActivenessAndLock.
- commitSet
The contracts and keys to be modified The commit set may only contain contracts and keys that have been locked in the corresponding activeness check. The transfer IDs in CommitSet.transferIns need not have been checked for activeness though.
- returns
The outer future completes when the conflict detector's internal state has been updated. The inner future completes when the updates have been persisted. com.digitalasset.canton.participant.protocol.conflictdetection.RequestTracker.RequestTrackerStoreErrors are signalled as scala.Left$. The futures may also fail with the following exceptions:
- IllegalConflictDetectionStateException if an internal error is detected. In particular if invariant checking is enabled and the invariant is violated. This exception is not recoverable.
- RequestTracker$.InvalidCommitSet if the
commitSetviolates its precondition. For the contract, key, and transfer state management, this case is treated like passing CommitSet.empty. - java.lang.IllegalArgumentException if the request is not in flight.
- Contracts in
- def getApproximateState(coid: LfContractId)(implicit traceContext: TraceContext): OptionT[Future, ContractState]
Returns the state of a contract, fetching it from the com.digitalasset.canton.participant.store.ActiveContractStore if it is not in memory.
Returns the state of a contract, fetching it from the com.digitalasset.canton.participant.store.ActiveContractStore if it is not in memory. If called concurrently, the state may only be outdated.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def internalPerformUnlessClosingF[A](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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- ConflictDetector → NamedLogging
- implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- 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 onClosed(): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def performUnlessClosing[A](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.- 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](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.- etf
The task to perform
- Definition Classes
- FlagCloseable
- def performUnlessClosingEitherTF[E, R](onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
- Definition Classes
- FlagCloseable
- def performUnlessClosingF[A](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.- 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 registerActivenessSet(rc: RequestCounter, activenessSet: ActivenessSet)(implicit traceContext: TraceContext): Future[Unit]
Registers a pending activeness set.
Registers a pending activeness set. This marks all contracts and keys in the
activenessSetwith a pending activeness check. If necessary, it creates in-memory states for them and fetches their latest state from the stores.May be called concurrently with any other method. Must be called before checkActivenessAndLock is called for the request.
- returns
The future completes once all states for contracts and keys in
activenessSethave been fetched from the stores and added to the in-memory conflict detection state. Errors from the stores fail the future as a LockableStates.ConflictDetectionStoreAccessError.
- def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit
Register a task that will run onClose after all "performUnlessShutdown" tasks have finished
Register a task that will run onClose after all "performUnlessShutdown" tasks have finished
- Definition Classes
- FlagCloseable
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- Annotations
- @VisibleForTesting()
- def sleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- ConflictDetector → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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])