class DbLockPostgres extends DbLock

A Postgres DB lock using advisory locks

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DbLockPostgres
  2. DbLock
  3. FlagCloseable
  4. PerformUnlessClosing
  5. OnShutdownRunner
  6. AutoCloseable
  7. NamedLogging
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 acquire()(implicit traceContext: TraceContext): EitherT[Future, DbLockError, Unit]

    A blocking acquisition of the lock.

    A blocking acquisition of the lock.

    Blocks until the lock has been acquired. A lock can only be acquired and attempted to be acquired once. A second attempt will fail even when the first attempt is still pending acquisition of the lock.

    Definition Classes
    DbLock
  5. def acquireInternal()(implicit traceContext: TraceContext): EitherT[Future, DbLockError, Unit]

    Internal (DB specific) blocking acquisition of the lock.

    Internal (DB specific) blocking acquisition of the lock.

    Definition Classes
    DbLockPostgresDbLock
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def cancelShutdownTask(token: Long): Unit

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Definition Classes
    OnShutdownRunner
  8. val clock: Clock
    Attributes
    protected
    Definition Classes
    DbLockPostgresDbLock
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. 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
  11. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  12. val config: DbLockConfig
    Attributes
    protected
    Definition Classes
    DbLockPostgresDbLock
  13. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  14. val database: slick.jdbc.JdbcBackend.Database
    Attributes
    protected
    Definition Classes
    DbLockPostgresDbLock
  15. implicit val ec: ExecutionContext
    Attributes
    protected
    Definition Classes
    DbLockPostgresDbLock
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  19. val executorShuttingDown: Eval[Boolean]
    Attributes
    protected
    Definition Classes
    DbLockPostgresDbLock
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def hasLock(implicit traceContext: TraceContext): EitherT[Future, DbLockError, Boolean]

    Check if the lock is still held by this session.

    Check if the lock is still held by this session.

    Attributes
    protected[resource]
    Definition Classes
    DbLockPostgresDbLock
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  24. def isAcquired: Boolean
    Definition Classes
    DbLock
  25. 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
    OnShutdownRunner
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def isLost: Boolean
    Definition Classes
    DbLock
  28. def isTaken(implicit traceContext: TraceContext): EitherT[Future, DbLockError, Boolean]

    Returns true if the lock is already taken by another session

    Returns true if the lock is already taken by another session

    Definition Classes
    DbLockPostgresDbLock
  29. 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
    PerformUnlessClosing
  30. val lockId: DbLockId

    The application-specific lock ID, which remains the same for the lifetime of the lock.

    The application-specific lock ID, which remains the same for the lifetime of the lock.

    Definition Classes
    DbLockPostgresDbLock
  31. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbLockPostgresNamedLogging
  33. def maxSleepMillis: Long

    How often to poll to check that all tasks have completed.

    How often to poll to check that all tasks have completed.

    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  34. val mode: DbLockMode
    Attributes
    protected
    Definition Classes
    DbLockPostgresDbLock
  35. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  41. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  42. 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
    Annotations
    @SuppressWarnings()
  43. 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
    PerformUnlessClosing
  44. 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
    PerformUnlessClosing
  45. 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
    PerformUnlessClosing
  46. 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
    PerformUnlessClosing
  47. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  48. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  49. 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
    PerformUnlessClosing
  50. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  51. val profile: Postgres
    Attributes
    protected
    Definition Classes
    DbLockPostgresDbLock
  52. def release()(implicit traceContext: TraceContext): EitherT[Future, DbLockError, Unit]

    Explicitly release the lock.

    Explicitly release the lock.

    Definition Classes
    DbLock
  53. def releaseInternal()(implicit traceContext: TraceContext): EitherT[Future, DbLockError, Unit]

    Internal (DB specific) release of the lock.

    Internal (DB specific) release of the lock.

    Definition Classes
    DbLockPostgresDbLock
  54. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Long

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Definition Classes
    OnShutdownRunner
  55. 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
    OnShutdownRunner
  56. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  57. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  58. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbLockPostgresDbLockFlagCloseable
  59. def toString(): String
    Definition Classes
    AnyRef → Any
  60. def tryAcquire()(implicit traceContext: TraceContext): EitherT[Future, DbLockError, Boolean]

    A non-blocking acquisition of the lock.

    A non-blocking acquisition of the lock.

    Tries to acquire the lock and immediately returns true or false if the lock was acquired or not. A lock can only be acquired and attempted to be acquired once.

    Definition Classes
    DbLock
  61. def tryAcquireInternal()(implicit traceContext: TraceContext): EitherT[Future, DbLockError, Boolean]

    Internal (DB specific) non-blocking acquisition of the lock.

    Internal (DB specific) non-blocking acquisition of the lock.

    Definition Classes
    DbLockPostgresDbLock
  62. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  63. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  64. 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
    Deprecated

Inherited from DbLock

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped