final class CompositeCancelable extends BooleanCancelable
Represents a composite of multiple cancelables. In case it is canceled, all contained cancelables will be canceled too, e.g...
val s = CompositeCancelable() s += c1 s += c2 s += c3 // c1, c2, c3 will also be canceled s.cancel()
Additionally, once canceled, on appending of new cancelable references, those references will automatically get canceled too:
val s = CompositeCancelable() s.cancel() // c1 gets canceled, because s is already canceled s += c1 // c2 gets canceled, because s is already canceled s += c2
Adding and removing references from this composite is thread-safe.
- Self Type
- CompositeCancelable
- Source
- CompositeCancelable.scala
- Alphabetic
- By Inheritance
- CompositeCancelable
- BooleanCancelable
- Cancelable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- def ++=(that: Iterable[Cancelable]): CompositeCancelable.this.type
Adds a collection of cancelables to this composite.
Adds a collection of cancelables to this composite.
If this composite is already canceled, then all the cancelables in the given collection will get canceled as well.
Alias for addAll.
- def +=(other: Cancelable): CompositeCancelable.this.type
Adds a cancelable reference to this composite.
Adds a cancelable reference to this composite.
If this composite is already canceled, then the given reference will be canceled as well.
Alias for add.
- def --=(that: Iterable[Cancelable]): CompositeCancelable.this.type
Removes a collection of cancelables from this composite.
Removes a collection of cancelables from this composite.
By removing references from the composite, we ensure that the removed references don't get canceled when the composite gets canceled. Also useful for garbage collecting purposes.
Alias for removeAll.
- def -=(s: Cancelable): CompositeCancelable.this.type
Removes a cancelable reference from this composite.
Removes a cancelable reference from this composite.
By removing references from the composite, we ensure that the removed references don't get canceled when the composite gets canceled. Also useful for garbage collecting purposes.
Alias for remove.
- def add(other: Cancelable): CompositeCancelable.this.type
Adds a cancelable reference to this composite.
Adds a cancelable reference to this composite.
If this composite is already canceled, then the given reference will be canceled as well.
- Annotations
- @tailrec()
- def addAll(that: Iterable[Cancelable]): CompositeCancelable.this.type
Adds a collection of cancelables to this composite.
Adds a collection of cancelables to this composite.
If this composite is already canceled, then all the cancelables in the given collection will get canceled as well.
- 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
- CompositeCancelable → Cancelable
- Annotations
- @tailrec()
- def getAndSet(that: Iterable[Cancelable]): Set[Cancelable]
Replaces the underlying set of cancelables with a new one, returning the old set just before the substitution happened.
- def isCanceled: Boolean
- returns
true in case this cancelable hasn't been canceled, or false otherwise.
- Definition Classes
- CompositeCancelable → BooleanCancelable
- def remove(s: Cancelable): CompositeCancelable.this.type
Removes a cancelable reference from this composite.
Removes a cancelable reference from this composite.
By removing references from the composite, we ensure that the removed references don't get canceled when the composite gets canceled. Also useful for garbage collecting purposes.
- Annotations
- @tailrec()
- def removeAll(that: Iterable[Cancelable]): CompositeCancelable.this.type
Removes a collection of cancelables from this composite.
Removes a collection of cancelables from this composite.
By removing references from the composite, we ensure that the removed references don't get canceled when the composite gets canceled. Also useful for garbage collecting purposes.
- def reset(): CompositeCancelable.this.type
Resets this composite to an empty state, if not canceled, otherwise leaves it in the canceled state.
Resets this composite to an empty state, if not canceled, otherwise leaves it in the canceled state.
- Annotations
- @tailrec()
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.