trait DbLock extends NamedLogging with FlagCloseable
Abstraction for an application-specific database lock.
The lock is identified by an integer and bound to the given database's session/connection.
If the connection is lost, the database releases the lock and the DbLock sets the lock state to Lost. The caller's connection management has to recreate and try to reacquire the lock with the given id. NOTE: The database must be configured with a single connection.
- Alphabetic
- By Inheritance
- DbLock
- FlagCloseable
- AutoCloseable
- NamedLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract 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.
- Attributes
- protected
- abstract def clock: Clock
- Attributes
- protected
- abstract def config: DbLockConfig
- Attributes
- protected
- abstract def database: slick.jdbc.JdbcBackend.Database
- Attributes
- protected
- implicit abstract def ec: ExecutionContext
- Attributes
- protected
- abstract def hasLock: 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]
- abstract def isTaken(implicit traceContext: TraceContext): EitherT[Future, DbLockError, Boolean]
Returns true if the lock is already taken by another session
- abstract def lockId: DbLockId
The application-specific lock ID, which remains the same for the lifetime of the lock.
- abstract def loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- NamedLogging
- abstract def mode: DbLockMode
- Attributes
- protected
- abstract def profile: Profile
- Attributes
- protected
- abstract def releaseInternal()(implicit traceContext: TraceContext): EitherT[Future, DbLockError, Unit]
Internal (DB specific) release of the lock.
Internal (DB specific) release of the lock.
- Attributes
- protected[resource]
- Annotations
- @VisibleForTesting()
- abstract def timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- DbLock → FlagCloseable
- abstract 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.
- Attributes
- protected
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- 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()
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def internalPerformUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def isAcquired: Boolean
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isLost: Boolean
- 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
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def onClosed(): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def performUnlessClosing[A](f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Performs the task given by
funless a shutdown has been initiated.Performs the task given by
funless a shutdown has been initiated. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, 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.- f
The task to perform
- returns
scala.None$ if a shutdown has been initiated. Otherwise the result of the task.
- Definition Classes
- FlagCloseable
- def performUnlessClosingEitherT[E, R](onClosing: => E)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, R]
Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead.Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead. Bothetfand the error are lazy;etfis only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin afteretfcompletes, but other tasks may execute concurrently withetf, 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.- etf
The task to perform
- Definition Classes
- FlagCloseable
- def performUnlessClosingEitherTF[E, R](onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
- Definition Classes
- FlagCloseable
- def performUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Performs the Future given by
funless a shutdown has been initiated.Performs the Future given by
funless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, 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.- 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
- def release()(implicit traceContext: TraceContext): EitherT[Future, DbLockError, Unit]
Explicitly release the lock.
- 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
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- Annotations
- @VisibleForTesting()
- def sleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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.
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])