class DbTransferStore extends TransferStore with DbStore
- Alphabetic
- By Inheritance
- DbTransferStore
- DbStore
- HasCloseContext
- NamedLogging
- FlagCloseable
- AutoCloseable
- TransferStore
- TransferLookup
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DbTransferStore(storage: DbStorage, domain: DomainId, protocolVersion: ProtocolVersion, cryptoApi: CryptoPureApi, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)
Type Members
- case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
- Definition Classes
- FlagCloseable
Value Members
- object ReaderState extends Serializable
- Definition Classes
- FlagCloseable
- 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 addTransfer(transferData: TransferData)(implicit traceContext: TraceContext): EitherT[Future, TransferStoreError, Unit]
Adds the transfer to the store.
Adds the transfer to the store.
Calls to this method are idempotent, independent of the order. Differences in protocol.transfer.TransferData!.transferOutResult between two calls are ignored if the field is scala.None$ in one of the calls. If applicable, the field content is merged.
- Definition Classes
- DbTransferStore → TransferStore
- Exceptions thrown
java.lang.IllegalArgumentExceptionif the transfer's target domain is not the domain this TransferStore belongs to.
- def addTransferOutResult(transferOutResult: DeliveredTransferOutResult)(implicit traceContext: TraceContext): EitherT[Future, TransferStoreError, Unit]
Adds the given com.digitalasset.canton.protocol.messages.TransferOutResult to the transfer data in the store, provided that the transfer data has previously been stored.
Adds the given com.digitalasset.canton.protocol.messages.TransferOutResult to the transfer data in the store, provided that the transfer data has previously been stored.
The same com.digitalasset.canton.protocol.messages.TransferOutResult can be added any number of times. This includes transfer-out results that are in the protocol.transfer.TransferData!.transferOutResult added with addTransfer.
- transferOutResult
The transfer-out result to add
- returns
TransferStore$.UnknownTransferId if the transfer has not previously been added with addTransfer. TransferStore$.TransferOutResultAlreadyExists if a different transfer-out result for the same transfer request has been added before, including as part of addTransfer.
- Definition Classes
- DbTransferStore → TransferStore
- 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()
- implicit val closeContext: CloseContext
- Definition Classes
- HasCloseContext
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def completeTransfer(transferId: TransferId, timeOfCompletion: TimeOfChange)(implicit traceContext: TraceContext): CheckedT[Future, Nothing, TransferStoreError, Unit]
Marks the transfer as completed, i.e., a transfer-in request was committed.
Marks the transfer as completed, i.e., a transfer-in request was committed. If the transfer has already been completed then a TransferStore.TransferAlreadyCompleted is reported, and the com.digitalasset.canton.participant.util.TimeOfChange of the completion is not changed from the old value.
- timeOfCompletion
Provides the request counter and activeness time of the committed transfer-in request.
- Definition Classes
- DbTransferStore → TransferStore
- def deleteCompletionsSince(criterionInclusive: RequestCounter)(implicit traceContext: TraceContext): Future[Unit]
Removes all completions of transfers that have been triggered by requests with at least the given counter.
Removes all completions of transfers that have been triggered by requests with at least the given counter. This method must not be called concurrently with completeTransfer, but may be called concurrently with addTransfer and addTransferOutResult.
Therefore, this method need not be linearizable w.r.t. completeTransfer. For example, if two requests
rc1complete two transfers while deleteCompletionsSince is running for somerc <= rc1, rc2, then there are no guarantees which of the completions ofrc1andrc2remain.- Definition Classes
- DbTransferStore → TransferStore
- def deleteTransfer(transferId: TransferId)(implicit traceContext: TraceContext): Future[Unit]
Removes the transfer from the store, when the transfer-out request is rejected or the transfer is pruned.
Removes the transfer from the store, when the transfer-out request is rejected or the transfer is pruned.
- Definition Classes
- DbTransferStore → TransferStore
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def find(filterOrigin: Option[DomainId], filterTimestamp: Option[CantonTimestamp], filterSubmitter: Option[LfPartyId], limit: Int)(implicit traceContext: TraceContext): Future[Seq[TransferData]]
Find utility to look for in-flight transfers.
Find utility to look for in-flight transfers. Queried by com.digitalasset.canton.console.commands.ParticipantAdministration#transfer.search. Results need not be consistent with lookup.
- Definition Classes
- DbTransferStore → TransferLookup
- def findAfter(requestAfter: Option[(CantonTimestamp, DomainId)], limit: Int)(implicit traceContext: TraceContext): Future[Seq[TransferData]]
Find utility to look for in-flight transfers.
Find utility to look for in-flight transfers. Transfers are ordered by the tuple (request timestamp, origin domain ID), ie transfers are ordered by request timestamps and ties are broken with lexicographic ordering on domain IDs.
The ordering here has been chosen to allow a participant to fetch all the pending transfers. The ordering has to be consistent accross calls and uniquely identify a pending transfer, but is otherwise arbitary.
- requestAfter
optionally, specify a strict lower bound for the transfers returned, according to the (request timestamp, origin domain ID) ordering
- limit
limit the number of results
- Definition Classes
- DbTransferStore → TransferLookup
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- implicit val getResultFullTransferOutTree: GetResult[FullTransferOutTree]
- implicit val getResultOptionDeliveredTransferOutResult: GetResult[Option[DeliveredTransferOutResult]]
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- FlagCloseable
- 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 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
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- DbTransferStore → NamedLogging
- implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- def lookup(transferId: TransferId)(implicit traceContext: TraceContext): EitherT[Future, TransferLookupError, TransferData]
Looks up the given in-flight transfer and returns the data associated with the transfer.
Looks up the given in-flight transfer and returns the data associated with the transfer.
- returns
scala.Left$(TransferStore.UnknownTransferId) if the transfer is unknown; scala.Left$(TransferStore.TransferCompleted) if the transfer has already been completed.
- Definition Classes
- DbTransferStore → TransferLookup
- def maxSleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- 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](name: String)(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.DO NOT CALL
this.closeas part off, 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
- 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
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.DO NOT CALL
this.closeas part ofetf, because it will result in a deadlock.- etf
The task to perform
- Definition Classes
- FlagCloseable
- 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
- def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- FlagCloseable
- def performUnlessClosingF[A](name: String)(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.DO NOT CALL
this.closeas part off, 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
- 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()
- implicit val setParameterDeliveredTransferOutResult: SetParameter[DeliveredTransferOutResult]
- implicit val setParameterFullTransferOutTree: SetParameter[FullTransferOutTree]
- implicit val setParameterOptionDeliveredTransferOutResult: SetParameter[Option[DeliveredTransferOutResult]]
- val storage: DbStorage
- Attributes
- protected
- Definition Classes
- DbTransferStore → DbStore
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- DbTransferStore → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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])