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 MVar2swap
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 generationMVar2
withtryRead
andswap
support- Source
- MVar.scala
- Alphabetic
- By Inheritance
- MVar
- MVarDocumentation
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new MVar()
Abstract Value Members
- abstract def isEmpty: F[Boolean]
Returns
true
if theMVar
is empty and can receive aput
, orfalse
otherwise.Returns
true
if theMVar
is empty and can receive aput
, orfalse
otherwise.Note that due to concurrent tasks, logic built in terms of
isEmpty
is problematic. - abstract def put(a: A): F[Unit]
Fills the
MVar
if it is empty, or blocks (asynchronously) if theMVar
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 theMVar
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 theMVar
, with the given value being next in line to be consumed
- 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
- 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
- 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
- abstract def tryTake: F[Option[A]]
empty the
MVar
if fullempty the
MVar
if full- returns
an Option holding the current value, None means it was empty
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def mapK[G[_]](f: ~>[F, G]): MVar[G, A]
Modify the context
F
using transformationf
.Modify the context
F
using transformationf
.- Annotations
- @deprecated
- Deprecated
(Since version 2.2.0)
mapK
is deprecated in favor ofimapK
which supports the new invariantMVar2
interface
This is the API documentation for the cats-effect library.
See the cats.effect package for a quick overview.
Links
Canonical documentation links:
Related Cats links (the core):