scala.concurrent.stm

CommitBarrier

trait CommitBarrier extends AnyRef

A CommitBarrier allows multiple transactions on separate threads to perform a single atomic commit. All of the actions performed by all of the atomic blocks executed by members of the barrier will appear to occur as a single atomic action, even though they are spread across multiple threads.

Commit barriers can be used to implement transactors, where actions taken by multiple actors should be atomic as a single unit.

Because there is no ordering possible between the atomic blocks that make up a commit barrier, if those transactions conflict then the only way to avoid deadlock is to roll back all of the barrier's members. If you observe a cancel cause of CommitBarrier.MemberCycle then this has happened to you, and you need to run more of the logic on a single thread inside a single transaction.

This abstraction is based on Multiverse's CountDownCommitBarrier, by Peter Veentjer.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CommitBarrier
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def addMember(cancelOnLocalRollback: Boolean = true)(implicit txn: MaybeTxn): Member

    Adds a new member to this coordinated commit and returns a Member instance that should be used to execute this member's atomic block.

    Adds a new member to this coordinated commit and returns a Member instance that should be used to execute this member's atomic block. If the existing members of this commit barrier have already completed (committed or rolled back) then it is not possible to join the commit and this method will throw IllegalStateException.

    If a member is added from inside a transaction and that transaction is later rolled back, the member will be removed from the commit barrier (by Member.cancel(CreatingTxnRolledBack)), unless cancelOnLocalRollback is false.

    cancelOnLocalRollback

    controls whether the newly created member will be automatically cancelled if this call to addMember is from inside a transaction that later rolls back

    Exceptions thrown
    IllegalStateException

    if this commit barrier has already been completed (committed or rolled back)

Concrete 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  16. def toString(): String

    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped