Type Members

1.  trait BinaryCodec[A] extends Encoder[A] with Decoder[A]

   Type class for encoding and decoding entity IDs to and from binary

2.  trait Branch[F[_], TID, Q, R] extends AnyRef

   A branch defines behavior for the various phases of the 2PC protocol for a certain transaction type.

   A branch defines behavior for the various phases of the 2PC protocol for a certain transaction type. The branch is responsible for preparing, committing and aborting the transaction. The coordinator instantiates a branch for each transaction and branch ID.

   F

   the effect type

   TID

   the transaction identifier type

   Q

   the query type

   R

   the abort reason type

3.  trait Coordinator[F[_], TID, BID, Q, R] extends AnyRef

   A coordinator allows for creating and recovering transactions of a certain type.

   A coordinator allows for creating and recovering transactions of a certain type. Internally, it implements the two-phase commit protocol to guarantee a final transaction state of either committed or aborted.

   F

   the effect type

   TID

   the transaction identifier type

   BID

   the branch identifier type

   Q

   the query type

   R

   the abort reason type

4.  trait StringCodec[A] extends EntityIDCodec[A]

   Type class for encoding and decoding entity IDs to and from strings

5.  trait Transaction[F[_], BID, Q, R] extends AnyRef

   This defines a handle to a distributed transaction, which can be used to inspect its status, retrieve its query and participating branches and trigger a client abort.

   This defines a handle to a distributed transaction, which can be used to inspect its status, retrieve its query and participating branches and trigger a client abort.

   F

   the effect type

   BID

   the branch identifier type

   Q

   the query type

   R

   the abort reason type

   Note

   Calling any of these methods will lead to transaction recovery. This side-effect can be used to implement resilience logic for pending transactions, if an alternative to remember-entities (enabled by default) is needed. For instance, pending transactions can be tracked in a persistent list and their status updated upon node restart - this will indirectly also ensure that preparation, commit and abort requests are re-issued if the node crashes during the transaction.

6.  trait Transactor[F[_]] extends AnyRef

   The transactor is the entrypoint provided by the underlying runtime to create distributed transaction coordinators for any type of transaction.

   The transactor is the entrypoint provided by the underlying runtime to create distributed transaction coordinators for any type of transaction.

   F

   the effect type