Packages

abstract class MVar[F[_], A] extends MVarDocumentation

A mutable location, that is either empty or contains a value of type A.

It has the following fundamental atomic operations:

  • put which fills the var if empty, or blocks (asynchronously) until the var is empty again
  • tryPut which fills the var if empty. returns true if successful
  • take which empties the var if full, returning the contained value, or blocks (asynchronously) otherwise until there is a value to pull
  • tryTake empties if full, returns None if empty.
  • read which reads the current value without touching it, assuming there is one, or otherwise it waits until a value is made available via put
  • tryRead returns a variable if it exists. Implemented in the successor MVar2
  • swap takes a value, replaces it and returns the taken value. Implemented in the successor MVar2
  • isEmpty returns true if currently empty

The MVar is appropriate for building synchronization primitives and performing simple inter-thread communications. If it helps, it's similar with a BlockingQueue(capacity = 1), except that it doesn't block any threads, all waiting being done asynchronously (via Async or Concurrent data types, such as IO).

Given its asynchronous, non-blocking nature, it can be used on top of Javascript as well.

Inspired by Control.Concurrent.MVar from Haskell and by scalaz.concurrent.MVar.

Annotations
@deprecated
Deprecated

(Since version 2.2.0) MVar is now deprecated in favour of a new generation MVar2 with tryRead and swap support

Source
MVar.scala
Linear Supertypes
MVarDocumentation, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MVar
  2. MVarDocumentation
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MVar()

Abstract Value Members

  1. abstract def isEmpty: F[Boolean]

    Returns true if the MVar is empty and can receive a put, or false otherwise.

    Returns true if the MVar is empty and can receive a put, or false otherwise.

    Note that due to concurrent tasks, logic built in terms of isEmpty is problematic.

  2. abstract def put(a: A): F[Unit]

    Fills the MVar if it is empty, or blocks (asynchronously) if the MVar is full, until the given value is next in line to be consumed on take.

    Fills the MVar if it is empty, or blocks (asynchronously) if the MVar is full, until the given value is next in line to be consumed on take.

    This operation is atomic.

    returns

    a task that on evaluation will complete when the put operation succeeds in filling the MVar, with the given value being next in line to be consumed

  3. abstract def read: F[A]

    Tries reading the current value, or blocks (asynchronously) until there is a value available.

    Tries reading the current value, or blocks (asynchronously) until there is a value available.

    This operation is atomic.

    returns

    a task that on evaluation will be completed after a value has been read

  4. abstract def take: F[A]

    Empties the MVar if full, returning the contained value, or blocks (asynchronously) until a value is available.

    Empties the MVar if full, returning the contained value, or blocks (asynchronously) until a value is available.

    This operation is atomic.

    returns

    a task that on evaluation will be completed after a value was retrieved

  5. abstract def tryPut(a: A): F[Boolean]

    Fill the MVar if we can do it without blocking,

    Fill the MVar if we can do it without blocking,

    returns

    whether or not the put succeeded

  6. abstract def tryTake: F[Option[A]]

    empty the MVar if full

    empty the MVar if full

    returns

    an Option holding the current value, None means it was empty

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() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def mapK[G[_]](f: ~>[F, G]): MVar[G, A]

    Modify the context F using transformation f.

    Modify the context F using transformation f.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.2.0) mapK is deprecated in favor of imapK which supports the new invariant MVar2 interface

Inherited from MVarDocumentation

Inherited from AnyRef

Inherited from Any

Ungrouped