class DbTransferStore extends TransferStore with DbStore

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DbTransferStore
  2. DbStore
  3. HasCloseContext
  4. PromiseUnlessShutdownFactory
  5. NamedLogging
  6. FlagCloseable
  7. PerformUnlessClosing
  8. OnShutdownRunner
  9. AutoCloseable
  10. TransferStore
  11. TransferLookup
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DbTransferStore(storage: DbStorage, domain: TargetDomainId, targetDomainProtocolVersion: TargetProtocolVersion, cryptoApi: CryptoPureApi, futureSupervisor: FutureSupervisor, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory, batchSize: Int = 500)(implicit ec: ExecutionContext)

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 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
    DbTransferStoreTransferStore
    Exceptions thrown

    java.lang.IllegalArgumentException if the transfer's target domain is not the domain this TransferStore belongs to.

  5. 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
    DbTransferStoreTransferStore
  6. def addTransfersOffsets(offsets: Map[TransferId, TransferGlobalOffset])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, TransferStoreError, Unit]

    Adds the given offsets to the transfer data in the store, provided that the transfer data has previously been stored.

    Adds the given offsets to the transfer data in the store, provided that the transfer data has previously been stored.

    The same offset can be added any number of times.

    Definition Classes
    DbTransferStoreTransferStore
  7. def addTransfersOffsets(events: Seq[(TransferId, TransferGlobalOffset)])(implicit executionContext: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, TransferStoreError, Unit]

    Adds the given com.digitalasset.canton.participant.GlobalOffset for the transfer events to the transfer data in the store, provided that the transfer data has previously been stored.

    Adds the given com.digitalasset.canton.participant.GlobalOffset for the transfer events to the transfer data in the store, provided that the transfer data has previously been stored.

    The same com.digitalasset.canton.participant.GlobalOffset can be added any number of times.

    Definition Classes
    TransferStore
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. 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
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  11. 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
  12. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  13. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  14. 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
    DbTransferStoreTransferStore
  15. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  16. 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 rc1 complete two transfers while deleteCompletionsSince is running for some rc <= rc1, rc2, then there are no guarantees which of the completions of rc1 and rc2 remain.

    Definition Classes
    DbTransferStoreTransferStore
  17. 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
    DbTransferStoreTransferStore
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  21. def find(filterSource: Option[SourceDomainId], 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
    DbTransferStoreTransferLookup
  22. def findAfter(requestAfter: Option[(CantonTimestamp, SourceDomainId)], 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, source 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 arbitrary.

    requestAfter

    optionally, specify a strict lower bound for the transfers returned, according to the (request timestamp, source domain ID) ordering

    limit

    limit the number of results

    Definition Classes
    DbTransferStoreTransferLookup
  23. def findIncomplete(sourceDomain: Option[SourceDomainId], validAt: GlobalOffset, stakeholders: Option[NonEmpty[Set[LfPartyId]]], limit: NonNegativeInt)(implicit traceContext: TraceContext): Future[Seq[IncompleteTransferData]]

    Find utility to look for incomplete transfers.

    Find utility to look for incomplete transfers. Transfers are ordered by global offset.

    A transfer t is considered as incomplete at offset validAt if only one of the two transfer events was emitted on the multi-domain event log at validAt. That is, one of the following hold:

    1. Only transfer-out was emitted
      • t.transferOutGlobalOffset is smaller or equal to validAt
      • t.transferInGlobalOffset is null or greater than validAt 2. Only transfer-in was emitted
      • t.transferInGlobalOffset is smaller or equal to validAt
      • t.transferOutGlobalOffset is null or greater than validAt

    In particular, for a transfer to be considered incomplete at validAt, then exactly one of the two offsets (transferOutGlobalOffset, transferInGlobalOffset) is not null and smaller or equal to validAt.

    sourceDomain

    if empty, select only transfers whose source domain matches the given one

    validAt

    select only transfers that are successfully transferred-out

    stakeholders

    if non-empty, select only transfers of contracts whose set of stakeholders intersects stakeholders.

    limit

    limit the number of results

    Definition Classes
    DbTransferStoreTransferLookup
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  26. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  27. def isClosing: Boolean

    Check whether we're closing.

    Check whether we're closing. Susceptible to race conditions; unless you're using this as a flag to the retry lib or you really know what you're doing, prefer performUnlessClosing and friends.

    Definition Classes
    OnShutdownRunner
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  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. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  31. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbTransferStoreNamedLogging
  32. 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
    DbTransferStoreTransferLookup
  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. def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext, ec: ExecutionContext): PromiseUnlessShutdown[A]

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed.

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed. This allows proper clean up of stray promises when the node is transitioning to a passive state.

    Note: you should *not* invoke success on the returned promise but rather use trySuccess. The reason is that the call to success may fail in case of shutdown.

    Definition Classes
    PromiseUnlessShutdownFactory
  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() @IntrinsicCandidate()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  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. 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
  52. 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
  53. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  54. val storage: DbStorage
    Attributes
    protected
    Definition Classes
    DbTransferStoreDbStore
  55. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  56. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbTransferStoreFlagCloseable
  57. def toString(): String
    Definition Classes
    AnyRef → Any
  58. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  59. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  60. 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 DbStore

Inherited from HasCloseContext

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from TransferStore

Inherited from TransferLookup

Inherited from AnyRef

Inherited from Any

Ungrouped