final class MultiAssignCancelable extends Multi
Represents a Cancelable whose underlying cancelable reference can be swapped for another.
Example:
val s = MultiAssignmentCancelable() s := c1 // sets the underlying cancelable to c1 s := c2 // swaps the underlying cancelable to c2 s.cancel() // also cancels c2 s := c3 // also cancels c3, because s is already canceled
Also see:
- SerialCancelable, which is similar, except that it cancels the old cancelable upon assigning a new cancelable
- SingleAssignCancelable that is effectively a forward reference that can be assigned at most once
- OrderedCancelable that's very similar with
MultiAssignCancelable, but with the capability of forcing ordering on concurrent updates
- Alphabetic
- By Inheritance
- MultiAssignCancelable
- Multi
- Bool
- BooleanCancelable
- AssignableCancelable
- Cancelable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- def :=(value: Cancelable): MultiAssignCancelable.this.type
Updates the internal reference of this assignable cancelable to the given value.
Updates the internal reference of this assignable cancelable to the given value.
If this cancelable is already canceled, then
valueis going to be canceled on assignment as well.- returns
this
- Definition Classes
- MultiAssignCancelable → AssignableCancelable
- Annotations
- @tailrec()
- def cancel(): Unit
Cancels the unit of work represented by this reference.
Cancels the unit of work represented by this reference.
Guaranteed idempotency - calling it multiple times should have the same side-effect as calling it only once. Implementations of this method should also be thread-safe.
- Definition Classes
- MultiAssignCancelable → Cancelable
- def clear(): Cancelable
Clears the underlying reference, setting it to a Cancelable.empty (if not cancelled).
Clears the underlying reference, setting it to a Cancelable.empty (if not cancelled).
This is equivalent with:
ref := Cancelable.empty
The purpose of this method is to release any underlying reference for GC purposes, however if the underlying reference is a dummy then the assignment doesn't happen because we don't care about releasing dummy references.
- Annotations
- @tailrec()
- def isCanceled: Boolean
- returns
true in case this cancelable hasn't been canceled, or false otherwise.
- Definition Classes
- MultiAssignCancelable → BooleanCancelable
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.