Object/Trait

scala.concurrent.stm

Ref

Related Docs: trait Ref | package stm

Permalink

object Ref extends RefCompanion

object Ref contains factory methods that allocate an STM-managed memory location and return a Ref instance that provides access to that location.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Ref
  2. RefCompanion
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait View[A] extends Source.View[A] with Sink.View[A]

    Permalink

    Ref.View provides access to the contents of a Ref without requiring that an implicit InTxn be available.

    Ref.View provides access to the contents of a Ref without requiring that an implicit InTxn be available. When called from within the dynamic scope of a transaction, View's methods operate as part of that transaction. When there is no transaction active View's methods are still atomic, but only for the duration of the method call.

    A mental model of View is that view.foo(args) acts like atomic { implicit t => view.ref.foo(args) }.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def apply(initialValue: Unit): Ref[Unit]

    Permalink
    Definition Classes
    RefCompanion
  5. def apply(initialValue: Double): Ref[Double]

    Permalink
    Definition Classes
    RefCompanion
  6. def apply(initialValue: Float): Ref[Float]

    Permalink
    Definition Classes
    RefCompanion
  7. def apply(initialValue: Long): Ref[Long]

    Permalink
    Definition Classes
    RefCompanion
  8. def apply(initialValue: Int): Ref[Int]

    Permalink
    Definition Classes
    RefCompanion
  9. def apply(initialValue: Char): Ref[Char]

    Permalink
    Definition Classes
    RefCompanion
  10. def apply(initialValue: Short): Ref[Short]

    Permalink
    Definition Classes
    RefCompanion
  11. def apply(initialValue: Byte): Ref[Byte]

    Permalink
    Definition Classes
    RefCompanion
  12. def apply(initialValue: Boolean): Ref[Boolean]

    Permalink
    Definition Classes
    RefCompanion
  13. def apply[A](initialValue: A)(implicit om: OptManifest[A]): Ref[A]

    Permalink

    Returns a Ref instance that manages a newly allocated memory location, initializing it to hold initialValue.

    Returns a Ref instance that manages a newly allocated memory location, initializing it to hold initialValue. The returned Ref is not part of any transaction's read or write set.

    Example:

    val x = Ref("initial") // creates a Ref[String]
    val list1 = Ref(Nil : List[String]) // creates a Ref[List[String]]
    val list2 = Ref[List[String]](Nil)  // creates a Ref[List[String]]
    Definition Classes
    RefCompanion
  14. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  15. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  16. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  18. def factory: RefFactory

    Permalink
    Attributes
    protected
    Definition Classes
    RefRefCompanion
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. def make[A]()(implicit om: OptManifest[A]): Ref[A]

    Permalink

    Returns a Ref instance that manages a newly allocated memory location holding values of type A.

    Returns a Ref instance that manages a newly allocated memory location holding values of type A. If you have an initial value v0 available, Ref(v0) should be preferred.

    Definition Classes
    RefCompanion
  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  27. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  28. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from RefCompanion

Inherited from AnyRef

Inherited from Any

Ungrouped