class DbRequestJournalStore extends RequestJournalStore with DbStore

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DbRequestJournalStore
  2. DbStore
  3. HasCloseContext
  4. NamedLogging
  5. FlagCloseable
  6. AutoCloseable
  7. RequestJournalStore
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DbRequestJournalStore(domainId: IndexedDomain, storage: DbStorage, maxItemsInSqlInClause: PositiveNumeric[Int], insertBatchAggregatorConfig: BatchAggregatorConfig, replaceBatchAggregatorConfig: BatchAggregatorConfig, enableAdditionalConsistencyChecksInOracle: Boolean, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)

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. def advancePreheadCleanTo(newPrehead: RequestCounterCursorPrehead)(implicit traceContext: TraceContext): Future[Unit]

    Sets the prehead counter for clean requests to rc with timestamp timestamp unless it has previously been set to the same or a higher value.

    Sets the prehead counter for clean requests to rc with timestamp timestamp unless it has previously been set to the same or a higher value.

    Definition Classes
    RequestJournalStore
  6. def advancePreheadCleanToTransactionalUpdate(newPrehead: RequestCounterCursorPrehead)(implicit traceContext: TraceContext): TransactionalStoreUpdate

    advancePreheadCleanTo as a com.digitalasset.canton.resource.TransactionalStoreUpdate

    advancePreheadCleanTo as a com.digitalasset.canton.resource.TransactionalStoreUpdate

    Definition Classes
    RequestJournalStore
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. 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()
  10. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  11. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  12. def deleteSince(fromInclusive: RequestCounter)(implicit traceContext: TraceContext): Future[Unit]

    Deletes all the requests with a request counter equal to or higher than the given request counter.

    Deletes all the requests with a request counter equal to or higher than the given request counter.

    Definition Classes
    DbRequestJournalStore → RequestJournalStore
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  16. def firstRequestWithCommitTimeAfter(commitTimeExclusive: CantonTimestamp)(implicit traceContext: TraceContext): Future[Option[RequestData]]

    Finds the request with the lowest request counter whose commit time is after the given timestamp

    Finds the request with the lowest request counter whose commit time is after the given timestamp

    Definition Classes
    DbRequestJournalStore → RequestJournalStore
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. implicit val getResultRequestData: GetResult[RequestData]
  19. implicit val getResultRequestState: GetResult[RequestState]
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def insert(data: RequestData)(implicit traceContext: TraceContext): Future[Unit]

    Adds the initial request information to the store.

    Adds the initial request information to the store.

    returns

    A failed future, if a request is inserted more than once with differing data

    Definition Classes
    DbRequestJournalStore → RequestJournalStore
  22. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  23. 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
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. 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
  26. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  27. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbRequestJournalStore → NamedLogging
  28. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  29. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. def onClosed(): Unit
    Definition Classes
    DbRequestJournalStore → FlagCloseable
  35. 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
  36. def performUnlessClosingCheckedT[A, N, R](name: String, onClosing: Checked[A, N, R])(etf: => CheckedT[Future, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[Future, A, N, R]
    Definition Classes
    FlagCloseable
  37. 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
  38. 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
  39. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  40. 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
  41. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    FlagCloseable
  42. def preheadClean(implicit traceContext: TraceContext): Future[Option[RequestCounterCursorPrehead]]

    Gets the prehead for the clean cursor.

    Gets the prehead for the clean cursor.

    Definition Classes
    RequestJournalStore
  43. def prune(beforeAndIncluding: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]

    Deletes all request counters at or before the given timestamp.

    Deletes all request counters at or before the given timestamp. Calls to this method are idempotent, independent of the order.

    Pre-conditions for the call:

    1. there must be a timestamp ts associated with the clean head 2. beforeAndIncluding < ts
    Definition Classes
    RequestJournalStore
    Exceptions thrown

    java.lang.IllegalArgumentException if the preconditions are violated.

  44. def query(rc: RequestCounter)(implicit traceContext: TraceContext): OptionT[Future, RequestData]

    Find request information by request counter

    Find request information by request counter

    Definition Classes
    DbRequestJournalStore → RequestJournalStore
  45. def repairRequests(fromInclusive: RequestCounter)(implicit traceContext: TraceContext): Future[Seq[RequestData]]

    Returns all repair requests at or after fromInclusive in ascending order.

    Returns all repair requests at or after fromInclusive in ascending order. This method must not be called concurrently with other methods of the store.

    Definition Classes
    DbRequestJournalStore → RequestJournalStore
  46. def replace(rc: RequestCounter, requestTimestamp: CantonTimestamp, oldState: RequestState, newState: RequestState, commitTime: Option[CantonTimestamp])(implicit traceContext: TraceContext): EitherT[Future, RequestJournalStoreError, Unit]

    Replaces the state of the request.

    Replaces the state of the request. The operation will only succeed if the current state is equal to the given oldState and the provided requestTimestamp matches the stored timestamp, or if the current state is already the new state. If so, the state gets replaced with newState and commitTime. If commitTime is scala.None$, the commit time will not be modified.

    The returned future may fail with a java.util.ConcurrentModificationException if the store detects a concurrent modification.

    requestTimestamp

    The sequencing time of the request.

    Definition Classes
    DbRequestJournalStore → RequestJournalStore
  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. implicit val setParameterRequestState: SetParameter[RequestState]
  50. def size(start: CantonTimestamp, end: Option[CantonTimestamp])(implicit traceContext: TraceContext): Future[Int]

    Counts requests whose timestamps lie between the given timestamps (inclusive).

    Counts requests whose timestamps lie between the given timestamps (inclusive).

    start

    Count all requests after or at the given timestamp

    end

    Count all requests before or at the given timestamp; use None to impose no upper limit

    Definition Classes
    DbRequestJournalStore → RequestJournalStore
  51. val storage: DbStorage
    Attributes
    protected
    Definition Classes
    DbRequestJournalStore → DbStore
  52. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  53. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbRequestJournalStore → FlagCloseable
  54. def toString(): String
    Definition Classes
    AnyRef → Any
  55. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  57. 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 DbStore

Inherited from HasCloseContext

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from AutoCloseable

Inherited from RequestJournalStore

Inherited from AnyRef

Inherited from Any

Ungrouped