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
RefCompanion, AnyRef, Any
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]

    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
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(initialValue: Unit): Ref[Unit]
    Definition Classes
    RefCompanion
  5. def apply(initialValue: Double): Ref[Double]
    Definition Classes
    RefCompanion
  6. def apply(initialValue: Float): Ref[Float]
    Definition Classes
    RefCompanion
  7. def apply(initialValue: Long): Ref[Long]
    Definition Classes
    RefCompanion
  8. def apply(initialValue: Int): Ref[Int]
    Definition Classes
    RefCompanion
  9. def apply(initialValue: Char): Ref[Char]
    Definition Classes
    RefCompanion
  10. def apply(initialValue: Short): Ref[Short]
    Definition Classes
    RefCompanion
  11. def apply(initialValue: Byte): Ref[Byte]
    Definition Classes
    RefCompanion
  12. def apply(initialValue: Boolean): Ref[Boolean]
    Definition Classes
    RefCompanion
  13. def apply[A](initialValue: A)(implicit om: OptManifest[A]): Ref[A]

    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
    Definition Classes
    Any
  15. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def factory: RefFactory
    Attributes
    protected
    Definition Classes
    Ref → RefCompanion
  19. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def make[A]()(implicit om: OptManifest[A]): Ref[A]

    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
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from RefCompanion

Inherited from AnyRef

Inherited from Any

Ungrouped