scala.concurrent.stm

Sink

trait Sink[-A] extends SinkLike[A, InTxn]

Sink[+A] consists of the contra-variant write-only operations of Ref[A].

Linear Supertypes
SinkLike[A, InTxn], AnyRef, Any
Known Subclasses
Ref
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Sink
  2. SinkLike
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def set(v: A)(implicit txn: InTxn): Unit

    Performs a transactional write.

    Performs a transactional write. The new value will not be visible by any other threads until (and unless) txn successfully commits. Equivalent to update(v).

    v

    a value to store in the Ref.

    Definition Classes
    SinkLike
    Exceptions thrown
    IllegalStateException

    if txn is not active.

  2. abstract def single: View[A]

    See Ref.single.

  3. abstract def trySet(v: A)(implicit txn: InTxn): Boolean

    Performs a transactional write and returns true, or returns false.

    Performs a transactional write and returns true, or returns false. The STM implementation may choose to return false to reduce (not necessarily avoid) blocking. If no other threads are performing any transactional or atomic accesses then this method will succeed.

    Definition Classes
    SinkLike

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. def update(v: A)(implicit txn: InTxn): Unit

    Performs a transactional write.

    Performs a transactional write. The new value will not be visible by any other threads until (and unless) txn successfully commits. Equivalent to set(v).

    Example: 

    val x = Ref(0)
atomic { implicit t =>
  ...
  x() = 10 // perform a write inside a transaction
  ...
}
    v

    a value to store in the Ref.

    Definition Classes
    SinkLike
    Exceptions thrown
    IllegalStateException

    if txn is not active.

  18. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from SinkLike[A, InTxn]

Inherited from AnyRef

Inherited from Any

Ungrouped