c

com.digitalasset.canton.participant.store.db

DbParticipantSettingsStore

class DbParticipantSettingsStore extends ParticipantSettingsStore with DbStore

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

Instance Constructors

  1. new DbParticipantSettingsStore(storage: DbStorage, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit executionContext: 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 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()
  3. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  4. def insertMaxDeduplicationDuration(maxDeduplicationDuration: NonNegativeFiniteDuration)(implicit traceContext: TraceContext): Future[Unit]

    Insert the given max deduplication duration provided unless a max deduplication duration has been set previously.

    Insert the given max deduplication duration provided unless a max deduplication duration has been set previously.

    Definition Classes
    DbParticipantSettingsStore → ParticipantSettingsStore
  5. def insertUniqueContractKeysMode(uniqueContractKeys: Boolean)(implicit traceContext: TraceContext): Future[Unit]

    Insert the setting for whether the participant provides unique-contract-key semantics.

    Insert the setting for whether the participant provides unique-contract-key semantics.

    Definition Classes
    DbParticipantSettingsStore → ParticipantSettingsStore
  6. 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
  7. 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
  8. 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
  9. 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
  10. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  11. 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
  12. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    FlagCloseable
  13. def refreshCache()(implicit traceContext: TraceContext): Future[Unit]
    Definition Classes
    DbParticipantSettingsStore → ParticipantSettingsStore
  14. 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
  15. final def settings: Settings

    returns

    the current settings

    Definition Classes
    ParticipantSettingsStore → ParticipantSettingsLookup
    Exceptions thrown

    java.lang.IllegalStateException if ParticipantSettingsStore.refreshCache has not previously been run successfully

  16. def writeResourceLimits(resourceLimits: ResourceLimits)(implicit traceContext: TraceContext): Future[Unit]
    Definition Classes
    DbParticipantSettingsStore → ParticipantSettingsStore