final class AtomicBoolean extends Atomic[Boolean]
Atomic references wrapping Boolean values.
Note that the equality test in compareAndSet is value based,
since Boolean is a primitive.
- Source
- AtomicBoolean.scala
- Alphabetic
- By Inheritance
- AtomicBoolean
- Atomic
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final macro def :=(value: Boolean): Unit
Alias for set.
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final macro def apply(): Boolean
Get the current value persisted by this Atomic, an alias for
get().Get the current value persisted by this Atomic, an alias for
get().- Definition Classes
- Atomic
- 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()
- def compareAndSet(expect: Boolean, update: Boolean): Boolean
Does a compare-and-set operation on the current value.
Does a compare-and-set operation on the current value. For more info, checkout the related Compare-and-swap Wikipedia page.
It's an atomic, worry free operation.
- expect
is the value you expect to be persisted when the operation happens
- update
will be the new value, should the check for
expectsucceeds- returns
either true in case the operation succeeded or false otherwise
- Definition Classes
- AtomicBoolean → Atomic
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def flip(update: Boolean): Boolean
Convenience method that expects the current value to be not the provided value.
Convenience method that expects the current value to be not the provided value. Equivalent to
compareAndSet(!update, update). - def get(): Boolean
Get the current value persisted by this Atomic.
Get the current value persisted by this Atomic.
- Definition Classes
- AtomicBoolean → Atomic
- def getAndSet(update: Boolean): Boolean
Sets the persisted value to
updateand returns the old value that was in place.Sets the persisted value to
updateand returns the old value that was in place. It's an atomic, worry free operation.- Definition Classes
- AtomicBoolean → Atomic
- final macro def getAndTransform(cb: (Boolean) => Boolean): Boolean
Abstracts over
compareAndSet.Abstracts over
compareAndSet. You specify a transformation by specifying a callback to be executed, a callback that transforms the current value. This method will loop until it will succeed in replacing the current value with the one produced by the given callback.Note that the callback will be executed on each iteration of the loop, so it can be called multiple times - don't do destructive I/O or operations that mutate global state in it.
- cb
is a callback that receives the current value as input and returns the
updatewhich is the new value that should be persisted- returns
the old value, just prior to when the successful update happened
- Definition Classes
- Atomic
- 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
- def lazySet(update: Boolean): Unit
Eventually sets to the given value.
Eventually sets to the given value. Has weaker visibility guarantees than the normal
set().- Definition Classes
- AtomicBoolean → Atomic
- 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()
- def set(update: Boolean): Unit
Updates the current value.
Updates the current value.
- update
will be the new value returned by
get()
- Definition Classes
- AtomicBoolean → Atomic
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AtomicBoolean → AnyRef → Any
- final macro def transform(cb: (Boolean) => Boolean): Unit
Abstracts over
compareAndSet.Abstracts over
compareAndSet. You specify a transformation by specifying a callback to be executed, a callback that transforms the current value. This method will loop until it will succeed in replacing the current value with the one produced by the given callback.Note that the callback will be executed on each iteration of the loop, so it can be called multiple times - don't do destructive I/O or operations that mutate global state in it.
- cb
is a callback that receives the current value as input and returns the
updatewhich is the new value that should be persisted
- Definition Classes
- Atomic
- final macro def transformAndExtract[U](cb: (Boolean) => (U, Boolean)): U
Abstracts over
compareAndSet.Abstracts over
compareAndSet. You specify a transformation by specifying a callback to be executed, a callback that transforms the current value. This method will loop until it will succeed in replacing the current value with the one produced by your callback.Note that the callback will be executed on each iteration of the loop, so it can be called multiple times - don't do destructive I/O or operations that mutate global state in it.
- cb
is a callback that receives the current value as input and returns a tuple that specifies the update + what should this method return when the operation succeeds.
- returns
whatever was specified by your callback, once the operation succeeds
- Definition Classes
- Atomic
- final macro def transformAndGet(cb: (Boolean) => Boolean): Boolean
Abstracts over
compareAndSet.Abstracts over
compareAndSet. You specify a transformation by specifying a callback to be executed, a callback that transforms the current value. This method will loop until it will succeed in replacing the current value with the one produced by the given callback.Note that the callback will be executed on each iteration of the loop, so it can be called multiple times - don't do destructive I/O or operations that mutate global state in it.
- cb
is a callback that receives the current value as input and returns the
updatewhich is the new value that should be persisted- returns
whatever the update is, after the operation succeeds
- Definition Classes
- Atomic
- final macro def update(value: Boolean): Unit
Alias for set.
- 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])
This is the API documentation for the Monix library.
Package Overview
monix.execution exposes lower level primitives for dealing with asynchronous execution:
Atomictypes, as alternative tojava.util.concurrent.atomicmonix.catnap exposes pure abstractions built on top of the Cats-Effect type classes:
monix.eval is for dealing with evaluation of results, thus exposing Task and Coeval.
monix.reactive exposes the
Observablepattern:Observableimplementationsmonix.tail exposes Iterant for purely functional pull based streaming:
BatchandBatchCursor, the alternatives to Scala'sIterableandIteratorrespectively that we are using within Iterant's encodingYou can control evaluation with type you choose - be it Task, Coeval, cats.effect.IO or your own as long as you provide correct cats-effect or cats typeclass instance.