com.digitalasset.canton.participant.store.memory
ReassignmentCache
Companion object ReassignmentCache
class ReassignmentCache extends ReassignmentLookup with NamedLogging with FlagCloseable
Adds an in-memory cache of pending completions on top of a store.ReassignmentStore. Completions appear atomic to reassignment lookups that go through the cache, even if they are written to the store only later.
- Alphabetic
 - By Inheritance
 
- ReassignmentCache
 - FlagCloseable
 - PerformUnlessClosing
 - HasSynchronizeWithReaders
 - HasSynchronizeWithClosing
 - OnShutdownRunner
 - HasRunOnClosing
 - HasUnlessClosing
 - AutoCloseable
 - NamedLogging
 - ReassignmentLookup
 - AnyRef
 - Any
 
- Hide All
 - Show All
 
- Public
 - Protected
 
Instance Constructors
-  new ReassignmentCache(reassignmentStore: ReassignmentStore, futureSupervisor: FutureSupervisor, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)
 
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
 
 -    def addReader(reader: String)(implicit traceContext: TraceContext): UnlessShutdown[ReaderHandle]
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
- Attributes
 - protected[this]
 - Definition Classes
 - HasSynchronizeWithReaders
 
 -   final  def asInstanceOf[T0]: T0
- Definition Classes
 - Any
 
 -    def clone(): AnyRef
- Attributes
 - protected[lang]
 - Definition Classes
 - AnyRef
 - Annotations
 - @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
 
 -   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 → OnShutdownRunner → AutoCloseable
 
 -    def closingTimeout: FiniteDuration
- Attributes
 - protected
 - Definition Classes
 - FlagCloseable → PerformUnlessClosing
 
 -    def completeReassignment(reassignmentId: ReassignmentId, tsCompletion: CantonTimestamp)(implicit traceContext: TraceContext): CheckedT[FutureUnlessShutdown, Nothing, ReassignmentStoreError, Unit]
Completes the given reassignment with the given
tsCompletion.Completes the given reassignment with the given
tsCompletion. Completion appears atomic to reassignment lookups that go through the cache.- returns
 The future completes when this completion or a completion of the same reassignment by an earlier request has been written to the underlying store.ReassignmentStore.
 -  implicit val ec: ExecutionContext
 -   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
 
 -    def findAfter(requestAfter: Option[(CantonTimestamp, Source[SynchronizerId])], limit: Int)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[UnassignmentData]]
Find utility to look for in-flight reassignments.
Find utility to look for in-flight reassignments. Reassignments are ordered by the tuple (request timestamp, source synchronizer id), ie reassignments are ordered by request timestamps and ties are broken with lexicographic ordering on synchronizer ids.
The ordering here has been chosen to allow a participant to fetch all the pending reassignments. The ordering has to be consistent accross calls and uniquely identify a pending reassignment, but is otherwise arbitrary.
- requestAfter
 optionally, specify a strict lower bound for the reassignments returned, according to the (request timestamp, source synchronizer id) ordering
- limit
 limit the number of results
- Definition Classes
 - ReassignmentCache → ReassignmentLookup
 
 -    def findContractReassignmentId(contractIds: Seq[LfContractId], sourceSynchronizer: Option[Source[SynchronizerId]], unassignmentTs: Option[CantonTimestamp], completionTs: Option[CantonTimestamp])(implicit traceContext: TraceContext): FutureUnlessShutdown[Map[LfContractId, Seq[ReassignmentId]]]
Queries the reassignment ids for the given contract ids.
Queries the reassignment ids for the given contract ids. Optional filtering by unassignment and completion (assignment) timestamps, and by source synchronizer.
- Definition Classes
 - ReassignmentCache → ReassignmentLookup
 
 -    def findEarliestIncomplete()(implicit traceContext: TraceContext): FutureUnlessShutdown[Option[(Offset, ReassignmentId, Target[SynchronizerId])]]
Find utility to look for the earliest incomplete reassignment w.r.t.
Find utility to look for the earliest incomplete reassignment w.r.t. the ledger end. If an incomplete reassignment exists, the method returns the global offset of the incomplete reassignment for either the unassignment or the assignment, whichever of these is not null, the reassignment id and the target synchronizer id. It returns None if there is no incomplete reassignment (either because all reassignments are complete or are in-flight, or because there are no reassignments), or the reassignment table is empty.
- Definition Classes
 - ReassignmentCache → ReassignmentLookup
 
 -    def findIncomplete(sourceSynchronizer: Option[Source[SynchronizerId]], validAt: Offset, stakeholders: Option[NonEmpty[Set[LfPartyId]]], limit: NonNegativeInt)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[IncompleteReassignmentData]]
unassignment/assignment global offsets will be updated upon publication on Ledger API Indexer, when the global offset is assigned to the event.
unassignment/assignment global offsets will be updated upon publication on Ledger API Indexer, when the global offset is assigned to the event. In order to avoid race conditions, the multi-synchronizer event log will wait for the calls to
ReassignmentStore.addReassignmentOffsetsto complete before updating ledger end. Hence, we don't need additional synchronization here and we can directly query the store.- sourceSynchronizer
 if empty, select only reassignments whose source synchronizer matches the given one
- validAt
 select only reassignments that are successfully unassigned
- stakeholders
 if non-empty, select only reassignments of contracts whose set of stakeholders intersects
stakeholders.- limit
 limit the number of results
- Definition Classes
 - ReassignmentCache → ReassignmentLookup
 
 -    def findReassignmentEntry(reassignmentId: ReassignmentId)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, UnknownReassignmentId, ReassignmentEntry]
- Definition Classes
 - ReassignmentCache → ReassignmentLookup
 
 -   final  def getClass(): Class[_ <: AnyRef]
- Definition Classes
 - AnyRef → Any
 - Annotations
 - @IntrinsicCandidate() @native()
 
 -    def hashCode(): Int
- Definition Classes
 - AnyRef → Any
 - Annotations
 - @IntrinsicCandidate() @native()
 
 -    def isClosing: Boolean
Check whether we're closing.
Check whether we're closing. Susceptible to race conditions; unless you're using this as a flag to the retry lib or you really know what you're doing, prefer
performUnlessClosingand friends.- Definition Classes
 - OnShutdownRunner → HasUnlessClosing
 
 -   final  def isInstanceOf[T0]: Boolean
- Definition Classes
 - Any
 
 -    def keepTrackOfReaderCallStack: Boolean
Set this to true to get detailed information about all futures that did not complete during shutdown.
Set this to true to get detailed information about all futures that did not complete during shutdown.
- Attributes
 - protected[this]
 - Definition Classes
 - PerformUnlessClosing → HasSynchronizeWithReaders
 
 -    def listInFlightReassignmentIds()(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[ReassignmentId]]
- Definition Classes
 - ReassignmentCache → ReassignmentLookup
 
 -    def logger: TracedLogger
- Attributes
 - protected
 - Definition Classes
 - NamedLogging
 
 -    val loggerFactory: NamedLoggerFactory
- Definition Classes
 - ReassignmentCache → NamedLogging
 
 -    def lookup(reassignmentId: ReassignmentId)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, ReassignmentLookupError, UnassignmentData]
Looks up the given in-flight reassignment and returns the data associated with the reassignment.
Looks up the given in-flight reassignment and returns the data associated with the reassignment.
- returns
 scala.Left$(ReassignmentStore.UnknownReassignmentId) if the reassignment is unknown; scala.Left$(ReassignmentStore.ReassignmentCompleted) if the reassignment has already been completed.
- Definition Classes
 - ReassignmentCache → ReassignmentLookup
 
 -    def nameInternal: String
- Attributes
 - protected[this]
 - Definition Classes
 - PerformUnlessClosing → HasSynchronizeWithReaders
 
 -   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
 - @IntrinsicCandidate() @native()
 
 -   final  def notifyAll(): Unit
- Definition Classes
 - AnyRef
 - Annotations
 - @IntrinsicCandidate() @native()
 
 -    def onCloseFailure(e: Throwable): Unit
- Attributes
 - protected
 - Definition Classes
 - PerformUnlessClosing
 
 -    def onClosed(): Unit
- Definition Classes
 - ReassignmentCache → PerformUnlessClosing
 
 -   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
 - PerformUnlessClosing → OnShutdownRunner
 
 -    def remainingReaders(): Seq[String]
- Attributes
 - protected[this]
 - Definition Classes
 - HasSynchronizeWithReaders
 
 -    def removeReader(handle: ReaderHandle): Unit
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
- Attributes
 - protected[this]
 - Definition Classes
 - HasSynchronizeWithReaders
 
 -    def runOnClose(task: RunOnClosing): UnlessShutdown[LifeCycleRegistrationHandle]
Schedules the given task to be run upon closing.
Schedules the given task to be run upon closing.
- returns
 An com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome indicates that the task will have been run when the
LifeCycleManager'scloseAsyncmethod completes or whenAutoCloseable'sclosemethod returns, unless the returnedLifeCycleRegistrationHandlewas used to cancel the task or the task has been done beforehand. com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if the task is not run due to closing. This always happens if isClosing returns true.
- Definition Classes
 - OnShutdownRunner → HasRunOnClosing
 
 -    def runOnOrAfterClose(task: RunOnClosing)(implicit traceContext: TraceContext): LifeCycleRegistrationHandle
Register a task to run when closing is initiated, or run it immediately if closing is already ongoing.
Register a task to run when closing is initiated, or run it immediately if closing is already ongoing. Unlike runOnClose, this method does not guarantee that this task will have run by the time the
LifeCycleManager'scloseAsyncmethod completes orAutoCloseable'sclosereturns. This is because the task is run immediately if the component has already been closed.- Definition Classes
 - HasRunOnClosing
 
 -   final  def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.
Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.
- Definition Classes
 - HasRunOnClosing
 
 -    def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
- Attributes
 - protected[this]
 - Definition Classes
 - OnShutdownRunner → HasRunOnClosing
 
 -    def synchronizeWithClosing[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F], A: CanAbortDueToShutdown[F]): F[A]
Runs the computation
fonly if the component is not yet closing.Runs the computation
fonly if the component is not yet closing. If so, the component will delay releasing its resources untilfhas completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatiencehas elapsed.DO NOT CALL
this.closeas part off, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef.- returns
 The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
fhas not run. Otherwise it is the result of runningf.
- Definition Classes
 - HasSynchronizeWithClosing
 - See also
 HasRunOnClosing.isClosing
 -    def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Convenience method for synchronizing on
Futures instead ofFutureUnlessShutdowns.Convenience method for synchronizing on
Futures instead ofFutureUnlessShutdowns. Equivalent tosynchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
- Definition Classes
 - PerformUnlessClosing
 
 -    def synchronizeWithClosingPatience: FiniteDuration
- Attributes
 - protected[this]
 - Definition Classes
 - PerformUnlessClosing → HasSynchronizeWithReaders
 
 -    def synchronizeWithClosingSync[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Runs the computation
fonly if the component is not yet closing.Runs the computation
fonly if the component is not yet closing. If so, the component will delay releasing its resources untilfhas finished or thesynchronizeWithClosingPatiencehas elapsed.DO NOT CALL
this.closeas part off, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef.- returns
 com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
fhas not run.
- Definition Classes
 - HasSynchronizeWithClosing
 - Annotations
 - @SuppressWarnings()
 - See also
 HasRunOnClosing.isClosing
 -    def synchronizeWithClosingUS[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
Runs the computation
fonly if the component is not yet closing.Runs the computation
fonly if the component is not yet closing. If so, the component will delay releasing its resources untilfhas completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatiencehas elapsed.DO NOT CALL
this.closeas part off, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef.- returns
 com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
fhas not run. Otherwise the result of runningf.
- Definition Classes
 - PerformUnlessClosing → HasSynchronizeWithClosing
 - See also
 HasRunOnClosing.isClosing
 -    def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
- Attributes
 - protected[this]
 - Definition Classes
 - HasSynchronizeWithReaders
 
 -   final  def synchronized[T0](arg0: => T0): T0
- Definition Classes
 - AnyRef
 
 -    val timeouts: ProcessingTimeout
- Attributes
 - protected
 - Definition Classes
 - ReassignmentCache → FlagCloseable
 
 -    def toString(): String
- Definition Classes
 - AnyRef → Any
 
 -   final  def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]
Runs the computation
faunless isClosing returns true.Runs the computation
faunless isClosing returns true.This method does not delay the closing while
fais running, unlike the methods inHasSynchronizeWithClosing. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.- returns
 The result of
faor com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if isClosing is true
- Definition Classes
 - HasUnlessClosing
 - Annotations
 - @inline()
 
 -   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])
 
 -   final  def wait(): Unit
- Definition Classes
 - AnyRef
 - Annotations
 - @throws(classOf[java.lang.InterruptedException])
 
 -    def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
- Attributes
 - protected[this]
 - Definition Classes
 - HasSynchronizeWithReaders