class DbReassignmentStore extends ReassignmentStore with DbStore

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DbReassignmentStore
  2. DbStore
  3. HasCloseContext
  4. PromiseUnlessShutdownFactory
  5. NamedLogging
  6. FlagCloseable
  7. PerformUnlessClosing
  8. HasSynchronizeWithReaders
  9. HasSynchronizeWithClosing
  10. OnShutdownRunner
  11. HasRunOnClosing
  12. HasUnlessClosing
  13. AutoCloseable
  14. ReassignmentStore
  15. ReassignmentLookup
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DbReassignmentStore(storage: DbStorage, indexedTargetSynchronizer: Target[IndexedSynchronizer], indexedStringStore: IndexedStringStore, futureSupervisor: FutureSupervisor, exitOnFatalFailures: Boolean, batchingConfig: BatchingConfig, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAssignmentDataIfAbsent(assignmentData: AssignmentData)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, ReassignmentStoreError, Unit]

    Inserts fake unassignmentRequestCounter into the database.

    Inserts fake unassignmentRequestCounter into the database. These will be overwritten once the unassignment is completed. If the reassignment data has already been inserted, this method will do nothing.

    Definition Classes
    DbReassignmentStoreReassignmentStore
  5. 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
  6. def addReassignmentsOffsets(offsets: Map[ReassignmentId, ReassignmentGlobalOffset])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, ReassignmentStoreError, Unit]

    Adds the given offsets to the reassignment data in the store.

    Adds the given offsets to the reassignment data in the store.

    The same offset can be added any number of times.

    Definition Classes
    DbReassignmentStoreReassignmentStore
  7. def addReassignmentsOffsets(events: Seq[(ReassignmentId, ReassignmentGlobalOffset)])(implicit executionContext: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, ReassignmentStoreError, Unit]

    Adds the given com.digitalasset.canton.data.Offset for the reassignment events to the reassignment data in the store, provided that the reassignment data has previously been stored.

    Adds the given com.digitalasset.canton.data.Offset for the reassignment events to the reassignment data in the store, provided that the reassignment data has previously been stored.

    The same com.digitalasset.canton.data.Offset can be added any number of times.

    Definition Classes
    ReassignmentStore
  8. def addUnassignmentData(unassignmentData: UnassignmentData)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, ReassignmentStoreError, Unit]

    Adds the unassignment data to the store.

    Adds the unassignment data to the store.

    Calls to this method are idempotent, independent of the order.

    Definition Classes
    DbReassignmentStoreReassignmentStore
    Exceptions thrown

    java.lang.IllegalArgumentException if the reassignment's target synchronizer is not the synchronizer this ReassignmentStore belongs to.

  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  11. 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
    FlagCloseableOnShutdownRunner → AutoCloseable
  12. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  13. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  14. def completeReassignment(reassignmentId: ReassignmentId, ts: CantonTimestamp)(implicit traceContext: TraceContext): CheckedT[FutureUnlessShutdown, Nothing, ReassignmentStoreError, Unit]

    Marks the reassignment as completed, i.e., an assignment request was committed.

    Marks the reassignment as completed, i.e., an assignment request was committed. If the reassignment has already been completed then a ReassignmentStore.ReassignmentAlreadyCompleted is reported, and the com.digitalasset.canton.data.CantonTimestamp of the completion is not changed from the old value.

    Definition Classes
    DbReassignmentStoreReassignmentStore
  15. def deleteCompletionsSince(criterionInclusive: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]

    Removes all completions of reassignments that have been triggered by requests with at least the given timestamp.

    Removes all completions of reassignments that have been triggered by requests with at least the given timestamp. This method must not be called concurrently with completeReassignment, but may be called concurrently with addUnassignmentData.

    Therefore, this method need not be linearizable w.r.t. completeReassignment. For example, if two requests at ts1 and ts2 complete two reassignments while deleteCompletionsSince is running for some ts <= ts1, ts2, then there are no guarantees which of the completions at ts1 and ts2 remain.

    Definition Classes
    DbReassignmentStoreReassignmentStore
  16. def deleteReassignment(reassignmentId: ReassignmentId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]

    Removes the reassignment from the store, when the unassignment request is rejected or the reassignment is pruned.

    Removes the reassignment from the store, when the unassignment request is rejected or the reassignment is pruned.

    Definition Classes
    DbReassignmentStoreReassignmentStore
  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 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
    DbReassignmentStoreReassignmentLookup
  21. 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
    DbReassignmentStoreReassignmentLookup
  22. 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
    DbReassignmentStoreReassignmentLookup
  23. def findIncomplete(sourceSynchronizer: Option[Source[SynchronizerId]], validAt: Offset, stakeholders: Option[NonEmpty[Set[LfPartyId]]], limit: NonNegativeInt)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[IncompleteReassignmentData]]

    Find utility to look for incomplete reassignments.

    Find utility to look for incomplete reassignments. Reassignments are ordered by global offset.

    A reassignment t is considered as incomplete at offset validAt if only one of the two reassignment events was emitted on the indexer at validAt. That is, one of the following hold:

    1. Only unassignment was emitted
      • t.unassignmentGlobalOffset is smaller or equal to validAt
      • t.assignmentGlobalOffset is null or greater than validAt 2. Only assignment was emitted
      • t.assignmentGlobalOffset is smaller or equal to validAt
      • t.unassignmentGlobalOffset is null or greater than validAt

    In particular, for a reassignment to be considered incomplete at validAt, then exactly one of the two offsets (unassignmentGlobalOffset, assignmentGlobalOffset) is not null and smaller or equal to validAt.

    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
    DbReassignmentStoreReassignmentLookup
  24. def findReassignmentEntry(reassignmentId: ReassignmentId)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, UnknownReassignmentId, ReassignmentEntry]
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  27. 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 performUnlessClosing and friends.

    Definition Classes
    OnShutdownRunnerHasUnlessClosing
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. 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
    PerformUnlessClosingHasSynchronizeWithReaders
  30. def listInFlightReassignmentIds()(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[ReassignmentId]]
  31. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbReassignmentStoreNamedLogging
  33. 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
    DbReassignmentStoreReassignmentLookup
  34. def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext): PromiseUnlessShutdown[A]

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed.

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed. This allows proper clean up of stray promises when the node is transitioning to a passive state.

    Note: you should *not* invoke success on the returned promise but rather use trySuccess. The reason is that the call to success may fail in case of shutdown.

    Definition Classes
    PromiseUnlessShutdownFactory
  35. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  36. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  41. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  42. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  43. 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
    PerformUnlessClosingOnShutdownRunner
  44. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  45. 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
  46. 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's closeAsync method completes or when AutoCloseable's close method returns, unless the returned LifeCycleRegistrationHandle was 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
    OnShutdownRunnerHasRunOnClosing
  47. 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's closeAsync method completes or AutoCloseable's close returns. This is because the task is run immediately if the component has already been closed.

    Definition Classes
    HasRunOnClosing
  48. final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit

    Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.

  49. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  50. implicit val setParameterReassignmentTagSynchronizerId: SetParameter[SynchronizerId]
  51. implicit val setParameterReassignmentTagSynchronizerIdO: SetParameter[Option[ReassignmentTag[SynchronizerId]]]
  52. val storage: DbStorage
    Attributes
    protected
    Definition Classes
    DbReassignmentStoreDbStore
  53. def synchronizeWithClosing[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F], A: CanAbortDueToShutdown[F]): F[A]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise it is the result of running f.

    Definition Classes
    HasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  54. def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns.

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns. Equivalent to

    synchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
    Definition Classes
    PerformUnlessClosing
  55. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  56. def synchronizeWithClosingSync[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has finished or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run.

    Definition Classes
    HasSynchronizeWithClosing
    Annotations
    @SuppressWarnings()
    See also

    HasRunOnClosing.isClosing

  57. def synchronizeWithClosingUS[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise the result of running f.

    Definition Classes
    PerformUnlessClosingHasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  58. def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  59. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  60. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbReassignmentStoreFlagCloseable
  61. def toString(): String
    Definition Classes
    AnyRef → Any
  62. final def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]

    Runs the computation fa unless isClosing returns true.

    Runs the computation fa unless isClosing returns true.

    This method does not delay the closing while fa is running, unlike the methods in HasSynchronizeWithClosing. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.

    returns

    The result of fa or com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if isClosing is true

    Definition Classes
    HasUnlessClosing
    Annotations
    @inline()
  63. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  64. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  65. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  66. def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from DbStore

Inherited from HasCloseContext

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from HasRunOnClosing

Inherited from HasUnlessClosing

Inherited from AutoCloseable

Inherited from ReassignmentStore

Inherited from ReassignmentLookup

Inherited from AnyRef

Inherited from Any

Ungrouped