abstract class MVar2[F[_], A] extends MVar[F, A]
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
.
The MVar2
is the successor of MVar
with tryRead and swap. It was implemented separately only to maintain
binary compatibility with MVar
.
- Annotations
- @nowarn()
- Source
- MVar.scala
- Alphabetic
- By Inheritance
- MVar2
- MVar
- MVarDocumentation
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new MVar2()
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.- Definition Classes
- MVar
- abstract def modify[B](f: (A) => F[(A, B)]): F[B]
Modifies the contents of the
MVar
using the effectful functionf
, but also allows for returning a value derived from the original contents of theMVar
.Modifies the contents of the
MVar
using the effectful functionf
, but also allows for returning a value derived from the original contents of theMVar
. Like use, in case of failure, it sets the contents of theMVar
to the original value.- f
effectful function that operates on the contents of this
MVar
- returns
the second value produced by applying
f
to the contents of thisMVar
- Note
This operation is only safe from deadlocks if there are no other producers for this
MVar
.
- abstract def modify_(f: (A) => F[A]): F[Unit]
Modifies the contents of the
MVar
using the effectful functionf
.Modifies the contents of the
MVar
using the effectful functionf
. Like use, in case of failure, it sets the contents of theMVar
to the original value.- f
effectful function that operates on the contents of this
MVar
- returns
no useful value. Executed only for the effects.
- Note
This operation is only safe from deadlocks if there are no other producers for this
MVar
.
- 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
- Definition Classes
- MVar
- 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
- Definition Classes
- MVar
- abstract def swap(newValue: A): F[A]
Replaces a value in MVar and returns the old value.
Replaces a value in MVar and returns the old value.
- newValue
is a new value
- returns
the value taken
- Note
This operation is only safe from deadlocks if there are no other producers for this
MVar
.
- 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
- Definition Classes
- MVar
- 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
- Definition Classes
- MVar
- abstract def tryRead: F[Option[A]]
A non-blocking version of read.
A non-blocking version of read.
- returns
an Option holding the current value, None means it was empty
- 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
- Definition Classes
- MVar
- abstract def use[B](f: (A) => F[B]): F[B]
Applies the effectful function
f
on the contents of thisMVar
.Applies the effectful function
f
on the contents of thisMVar
. In case of failure, it sets the contents of theMVar
to the original value.- f
effectful function that operates on the contents of this
MVar
- returns
the value produced by applying
f
to the contents of thisMVar
- Note
This operation is only safe from deadlocks if there are no other producers for this
MVar
.
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()
- def imapK[G[_]](f: ~>[F, G], g: ~>[G, F]): MVar2[G, A]
Modify the context
F
using natural isomorphismf
withg
.Modify the context
F
using natural isomorphismf
withg
.- f
functor transformation from
F
toG
- g
functor transformation from
G
toF
- returns
MVar2
with a modified contextG
derived using a natural isomorphism fromF
- 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
.- Definition Classes
- MVar
- 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):