c

com.digitalasset.canton.store.db

DbCursorPreheadStore

class DbCursorPreheadStore[Counter <: Long] extends CursorPreheadStore[Counter] with DbStore

DB storage for a cursor prehead for a domain

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

Instance Constructors

  1. new DbCursorPreheadStore(client: SequencerClientDiscriminator, storage: DbStorage, cursorTable: String, processingTime: GaugeM[TimedLoadGauge, Double], timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit arg0: GetResult[Counter], ec: ExecutionContext)

    cursorTable

    The table name to store the cursor prehead. The table must define the following columns:

    • client varchar not null primary key
    • prehead_counter bigint not null
    • ts bigint not null
    processingTime

    The metric to be used for DB queries

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 advancePreheadTo(newPrehead: CursorPrehead[Counter])(implicit traceContext: TraceContext): Future[Unit]

    Sets the prehead counter to newPrehead unless it is already at the same or a higher value.

    Sets the prehead counter to newPrehead unless it is already at the same or a higher value. The prehead counter should be set to the counter before the head of the corresponding cursor.

    Definition Classes
    CursorPreheadStore
  6. def advancePreheadToTransactionalStoreUpdate(newPrehead: CursorPrehead[Counter])(implicit traceContext: TraceContext): TransactionalStoreUpdate

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

  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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  17. 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
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. 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
  20. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  21. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbCursorPreheadStoreNamedLogging
  22. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  23. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
  29. 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
  30. 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
  31. 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
  32. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  33. 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
  34. def prehead(implicit traceContext: TraceContext): Future[Option[CursorPrehead[Counter]]]

    Gets the prehead of the cursor.

    Gets the prehead of the cursor.

    Definition Classes
    DbCursorPreheadStoreCursorPreheadStore
    Annotations
    @nowarn()
  35. def rewindPreheadTo(newPreheadO: Option[CursorPrehead[Counter]])(implicit traceContext: TraceContext): Future[Unit]

    Sets the prehead counter to newPreheadO if it is currently set to a higher value.

    Sets the prehead counter to newPreheadO if it is currently set to a higher value.

    Definition Classes
    DbCursorPreheadStoreCursorPreheadStore
  36. 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
  37. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  38. val storage: DbStorage
    Attributes
    protected
    Definition Classes
    DbCursorPreheadStoreDbStore
  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbCursorPreheadStoreFlagCloseable
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  44. 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 CursorPreheadStore[Counter]

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped