Class/Object

zio.Ref

Synchronized

Related Docs: object Synchronized | package Ref

Permalink

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, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Synchronized
  2. Ref
  3. Serializable
  4. Serializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Synchronized()

    Permalink

Abstract Value Members

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

    Permalink

    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: ZTraceElement): ZIO[R, E, B]

    Permalink

    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: ZTraceElement): UIO[Unit]

    Permalink

    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: ZTraceElement): UIO[Unit]

    Permalink

    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

    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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

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

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

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

  9. final def getAndSet(a: A)(implicit trace: ZTraceElement): UIO[A]

    Permalink

    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

  10. final def getAndUpdate(f: (A) ⇒ A)(implicit trace: ZTraceElement): UIO[A]

    Permalink

    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

  11. final def getAndUpdateSome(pf: PartialFunction[A, A])(implicit trace: ZTraceElement): UIO[A]

    Permalink

    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

  12. def getAndUpdateSomeZIO[R, E](pf: PartialFunction[A, ZIO[R, E, A]])(implicit trace: ZTraceElement): ZIO[R, E, A]

    Permalink

    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.

  13. def getAndUpdateZIO[R, E](f: (A) ⇒ ZIO[R, E, A])(implicit trace: ZTraceElement): ZIO[R, E, A]

    Permalink

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

  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  15. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  17. final def modify[B](f: (A) ⇒ (B, A))(implicit trace: ZTraceElement): UIO[B]

    Permalink

    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

  18. final def modifySome[B](default: B)(pf: PartialFunction[A, (B, A)])(implicit trace: ZTraceElement): UIO[B]

    Permalink

    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

  19. def modifySomeZIO[R, E, B](default: B)(pf: PartialFunction[A, ZIO[R, E, (B, A)]])(implicit trace: ZTraceElement): ZIO[R, E, B]

    Permalink

    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.

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  25. final def update(f: (A) ⇒ A)(implicit trace: ZTraceElement): UIO[Unit]

    Permalink

    Atomically modifies the Ref with the specified function.

    Atomically modifies the Ref with the specified function.

    Definition Classes
    Ref

  26. final def updateAndGet(f: (A) ⇒ A)(implicit trace: ZTraceElement): UIO[A]

    Permalink

    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

  27. def updateAndGetZIO[R, E](f: (A) ⇒ ZIO[R, E, A])(implicit trace: ZTraceElement): ZIO[R, E, A]

    Permalink

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

  28. final def updateSome(pf: PartialFunction[A, A])(implicit trace: ZTraceElement): UIO[Unit]

    Permalink

    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

  29. final def updateSomeAndGet(pf: PartialFunction[A, A])(implicit trace: ZTraceElement): UIO[A]

    Permalink

    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

  30. def updateSomeAndGetZIO[R, E](pf: PartialFunction[A, ZIO[R, E, A]])(implicit trace: ZTraceElement): ZIO[R, E, A]

    Permalink

    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.

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

    Permalink

    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.

  32. def updateZIO[R, E](f: (A) ⇒ ZIO[R, E, A])(implicit trace: ZTraceElement): ZIO[R, E, Unit]

    Permalink

    Atomically modifies the Ref.Synchronized with the specified function.

  33. final def wait(): Unit

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

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

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

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

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

Deprecated Value Members

  1. def getAndUpdateM[R, E](f: (A) ⇒ ZIO[R, E, A])(implicit trace: ZTraceElement): ZIO[R, E, A]

    Permalink

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

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use getAndUpdateZIO

  2. def getAndUpdateSomeM[R, E](pf: PartialFunction[A, ZIO[R, E, A]])(implicit trace: ZTraceElement): ZIO[R, E, A]

    Permalink

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

    Atomically modifies the RefM 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.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use getAndUpdateSomeZIO

  3. def modifyM[R, E, B](f: (A) ⇒ ZIO[R, E, (B, A)])(implicit trace: ZTraceElement): ZIO[R, E, B]

    Permalink

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

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use modifyZIO

  4. def modifySomeM[R, E, B](default: B)(pf: PartialFunction[A, ZIO[R, E, (B, A)]])(implicit trace: ZTraceElement): ZIO[R, E, B]

    Permalink

    Atomically modifies the RefM 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 RefM 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.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use modifySomeZIO

  5. def updateAndGetM[R, E](f: (A) ⇒ ZIO[R, E, A])(implicit trace: ZTraceElement): ZIO[R, E, A]

    Permalink

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

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use updateAndGetZIO

  6. def updateM[R, E](f: (A) ⇒ ZIO[R, E, A])(implicit trace: ZTraceElement): ZIO[R, E, Unit]

    Permalink

    Atomically modifies the RefM with the specified function.

    Atomically modifies the RefM with the specified function.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use updateZIO

  7. def updateSomeAndGetM[R, E](pf: PartialFunction[A, ZIO[R, E, A]])(implicit trace: ZTraceElement): ZIO[R, E, A]

    Permalink

    Atomically modifies the RefM with the specified partial function.

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use updateSomeAndGetZIO

  8. def updateSomeM[R, E](pf: PartialFunction[A, ZIO[R, E, A]])(implicit trace: ZTraceElement): ZIO[R, E, Unit]

    Permalink

    Atomically modifies the RefM with the specified partial function.

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use updateSomeZIO

Inherited from Ref[A]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped