Packages

class AsyncTransactions extends AnyRef

An asynchronous version of Transactions, allowing transactions to be created and run in an asynchronous manner using scala.concurrent.Future.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AsyncTransactions
  2. AnyRef
  3. 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. def run(transactionLogic: (AsyncTransactionAttemptContext) => Future[Unit]): Future[TransactionResult]

    A convenience overload of AsyncTransactions.run() that provides default options.

  15. def run(transactionLogic: (AsyncTransactionAttemptContext) => Future[Unit], options: TransactionOptions): Future[TransactionResult]

    Runs the supplied transactional logic until success or failure.

    Runs the supplied transactional logic until success or failure.

    This is the asynchronous version of Transactions.run(), so to cover the differences:

    • The transaction logic is supplied with a AsyncTransactionAttemptContext, which contains asynchronous methods to allow it to read, mutate, insert and delete documents.
    • The transaction logic should return a Future[Unit].
    • This method returns a Future[TransactionResult], which should be handled as a normal Scala Future.
    transactionLogic

    the application's transaction logic

    options

    the configuration to use for this transaction

    returns

    there is no need to check the returned TransactionResult, as success is implied by the lack of a raised Future.failed(). It contains information useful only for debugging and logging. Will return Future.failed(TransactionFailedException) or a derived exception if the transaction fails for any reason, possibly after multiple retries. The exception contains further details of the error.

  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. 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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped