Packages

abstract class Synchronized[A] extends Ref[A]

A Ref.Synchronized is a purely functional description of a mutable reference. The fundamental operations of a Ref.Synchronized are set and get. set sets the reference to a new value. get gets the current value of the reference.

Unlike an ordinary Ref, a Ref.Synchronized allows performing effects within update operations, at some cost to performance. Writes will semantically block other writers, while multiple readers can read simultaneously.

Linear Supertypes
Ref[A], Serializable, AnyRef, Any
Known Subclasses
SubscriptionRef
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Synchronized
  2. Ref
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Synchronized()

Abstract Value Members

  1. abstract def get(implicit trace: Trace): UIO[A]

    Reads the value from the Ref.

    Reads the value from the Ref.

    Definition Classes
    Synchronized → Ref
  2. abstract def modifyZIO[R, E, B](f: (A) => ZIO[R, E, (B, A)])(implicit trace: Trace): ZIO[R, E, B]

    Atomically modifies the Ref.Synchronized with the specified function, which computes a return value for the modification.

    Atomically modifies the Ref.Synchronized with the specified function, which computes a return value for the modification. This is a more powerful version of update.

  3. abstract def set(a: A)(implicit trace: Trace): UIO[Unit]

    Writes a new value to the Ref, with a guarantee of immediate consistency (at some cost to performance).

    Writes a new value to the Ref, with a guarantee of immediate consistency (at some cost to performance).

    Definition Classes
    Synchronized → Ref
  4. abstract def setAsync(a: A)(implicit trace: Trace): UIO[Unit]

    Writes a new value to the Ref without providing a guarantee of immediate consistency.

    Writes a new value to the Ref without providing a guarantee of immediate consistency.

    Definition Classes
    Synchronized → Ref

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def getAndSet(a: A)(implicit trace: Trace): UIO[A]

    Atomically writes the specified value to the Ref, returning the value immediately before modification.

    Atomically writes the specified value to the Ref, returning the value immediately before modification.

    Definition Classes
    Ref
  9. def getAndUpdate(f: (A) => A)(implicit trace: Trace): UIO[A]

    Atomically modifies the Ref with the specified function, returning the value immediately before modification.

    Atomically modifies the Ref with the specified function, returning the value immediately before modification.

    Definition Classes
    Ref
  10. def getAndUpdateSome(pf: PartialFunction[A, A])(implicit trace: Trace): UIO[A]

    Atomically modifies the Ref with the specified partial function, returning the value immediately before modification.

    Atomically modifies the Ref with the specified partial function, returning the value immediately before modification. If the function is undefined on the current value it doesn't change it.

    Definition Classes
    Ref
  11. def getAndUpdateSomeZIO[R, E](pf: PartialFunction[A, ZIO[R, E, A]])(implicit trace: Trace): ZIO[R, E, A]

    Atomically modifies the Ref.Synchronized with the specified partial function, returning the value immediately before modification.

    Atomically modifies the Ref.Synchronized with the specified partial function, returning the value immediately before modification. If the function is undefined on the current value it doesn't change it.

  12. def getAndUpdateZIO[R, E](f: (A) => ZIO[R, E, A])(implicit trace: Trace): ZIO[R, E, A]

    Atomically modifies the Ref.Synchronized with the specified function, returning the value immediately before modification.

  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def modify[B](f: (A) => (B, A))(implicit trace: Trace): UIO[B]

    Atomically modifies the Ref with the specified function, which computes a return value for the modification.

    Atomically modifies the Ref with the specified function, which computes a return value for the modification. This is a more powerful version of update.

    Definition Classes
    Synchronized → Ref
  17. def modifySome[B](default: B)(pf: PartialFunction[A, (B, A)])(implicit trace: Trace): UIO[B]

    Atomically modifies the Ref with the specified partial function, which computes a return value for the modification if the function is defined on the current value otherwise it returns a default value.

    Atomically modifies the Ref with the specified partial function, which computes a return value for the modification if the function is defined on the current value otherwise it returns a default value. This is a more powerful version of updateSome.

    Definition Classes
    Ref
  18. def modifySomeZIO[R, E, B](default: B)(pf: PartialFunction[A, ZIO[R, E, (B, A)]])(implicit trace: Trace): ZIO[R, E, B]

    Atomically modifies the Ref.Synchronized with the specified function, which computes a return value for the modification if the function is defined in the current value otherwise it returns a default value.

    Atomically modifies the Ref.Synchronized with the specified function, which computes a return value for the modification if the function is defined in the current value otherwise it returns a default value. This is a more powerful version of updateSome.

  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. def update(f: (A) => A)(implicit trace: Trace): UIO[Unit]

    Atomically modifies the Ref with the specified function.

    Atomically modifies the Ref with the specified function.

    Definition Classes
    Ref
  25. def updateAndGet(f: (A) => A)(implicit trace: Trace): UIO[A]

    Atomically modifies the Ref with the specified function and returns the updated value.

    Atomically modifies the Ref with the specified function and returns the updated value.

    Definition Classes
    Ref
  26. def updateAndGetZIO[R, E](f: (A) => ZIO[R, E, A])(implicit trace: Trace): ZIO[R, E, A]

    Atomically modifies the Ref.Synchronized with the specified function, returning the value immediately after modification.

  27. def updateSome(pf: PartialFunction[A, A])(implicit trace: Trace): UIO[Unit]

    Atomically modifies the Ref with the specified partial function.

    Atomically modifies the Ref with the specified partial function. If the function is undefined on the current value it doesn't change it.

    Definition Classes
    Ref
  28. def updateSomeAndGet(pf: PartialFunction[A, A])(implicit trace: Trace): UIO[A]

    Atomically modifies the Ref with the specified partial function.

    Atomically modifies the Ref with the specified partial function. If the function is undefined on the current value it returns the old value without changing it.

    Definition Classes
    Ref
  29. def updateSomeAndGetZIO[R, E](pf: PartialFunction[A, ZIO[R, E, A]])(implicit trace: Trace): ZIO[R, E, A]

    Atomically modifies the Ref.Synchronized with the specified partial function.

    Atomically modifies the Ref.Synchronized with the specified partial function. If the function is undefined on the current value it returns the old value without changing it.

  30. def updateSomeZIO[R, E](pf: PartialFunction[A, ZIO[R, E, A]])(implicit trace: Trace): ZIO[R, E, Unit]

    Atomically modifies the Ref.Synchronized with the specified partial function.

    Atomically modifies the Ref.Synchronized with the specified partial function. If the function is undefined on the current value it doesn't change it.

  31. def updateZIO[R, E](f: (A) => ZIO[R, E, A])(implicit trace: Trace): ZIO[R, E, Unit]

    Atomically modifies the Ref.Synchronized with the specified function.

  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Ref[A]

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped