Represents a class of cancelables that can hold an internal reference to another cancelable (and thus has to support the assignment operator).
Represents a class of cancelables that can hold an internal reference to another cancelable (and thus has to support the assignment operator).
Examples are the MultiAssignmentCancelable and the SingleAssignmentCancelable.
On assignment, if this cancelable is already canceled, then no assignment should happen and the update reference should be canceled as well.
Represents a Cancelable that can be queried for the canceled status.
Represents a monix.execution.Cancelable whose underlying cancelable reference can be swapped for another.
Represents a monix.execution.Cancelable whose underlying
cancelable reference can be swapped for another. It can
be "chained" to another ChainedCancelable
, forwarding all
operations to it.
For most purposes it works like a MultiAssignmentCancelable:
val s = ChainedCancelable() 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
However it can also be linked to another ChainedCancelable
reference, forwarding all requests to it:
val source = ChainedCancelable() val child1 = ChainedCancelable() val child2 = ChainedCancelable() // Hence forth forwards all operations on `child1` to `source` child1.chainTo(source) // Also forwarding all `child2` operations to `source`. // This happens because `child1` was linked to `source` first // but order matters, as `child2` will be linked directly // to `source` and not to `child1`, in order for `child1` to // be garbage collected if it goes out of scope ;-) child2.chainTo(child1) // Source will be updated with a new Cancelable ref child1 := Cancelable(() => println("Cancelling (1)")) // Source will be updated with another Cancelable ref child2 := Cancelable(() => println("Cancelling (2)")) source.cancel() //=> Cancelling (2)
This implementation is a special purpose AssignableCancelable,
much like StackedCancelable, to be used in flatMap
implementations that need it.
The problem that it solves in Monix's codebase is that various
flatMap
implementations need to be memory safe.
By "chaining" cancelable references, we allow the garbage collector
to get rid of references created in a flatMap
loop, the goal
being to consume a constant amount of memory. Thus this
implementation is used for
CancelableFuture.
If unsure about what to use, then you probably don't need ChainedCancelable. Use MultiAssignmentCancelable or SingleAssignmentCancelable for most purposes.
Represents a composite of multiple cancelables.
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.
Represents a monix.execution.Cancelable whose underlying cancelable reference can be swapped for another.
Represents a monix.execution.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.
Represents a Cancelable
that only executes the canceling logic when all
dependent cancelable objects have been canceled.
Represents a Cancelable
that only executes the canceling logic when all
dependent cancelable objects have been canceled.
The given callback gets called after our RefCountCancelable
is canceled
and after all dependent cancelables have been canceled along with the
main cancelable.
In other words, lets say for example that we have acquired
2 children.
In order for the cancelable to get canceled, we need to:
RefCountCancelable
The implementation is thread-safe and cancellation order doesn't matter.
Represents a monix.execution.Cancelable whose underlying cancelable can be swapped for another cancelable which causes the previous underlying cancelable to be canceled.
Represents a monix.execution.Cancelable whose underlying cancelable can be swapped for another cancelable which causes the previous underlying cancelable to be canceled.
Example:
val s = SerialCancelable() s := c1 // sets the underlying cancelable to c1 s := c2 // cancels c1 and swaps the underlying cancelable to c2 s.cancel() // also cancels c2 s := c3 // also cancels c3, because s is already canceled
Also see MultiAssignmentCancelable, which is similar, but doesn't cancel the old cancelable upon assignment.
Represents a monix.execution.Cancelable that can be assigned only once to another cancelable reference.
Represents a monix.execution.Cancelable that can be assigned only once to another cancelable reference.
Similar to monix.execution.cancelables.MultiAssignmentCancelable,
except that in case of multi-assignment, it throws a
java.lang.IllegalStateException
.
If the assignment happens after this cancelable has been canceled, then on assignment the reference will get canceled too.
Useful in case you need a forward reference.
Represents a composite of cancelables that are stacked, so you can push a new reference, or pop an existing one and when it gets canceled, then the whole stack gets canceled.
Represents a composite of cancelables that are stacked, so you can push a new reference, or pop an existing one and when it gets canceled, then the whole stack gets canceled.
Similar in spirit with CompositeCancelable, except that you can only pull out references in a FIFO fashion.
Used in the implementation of monix.eval.Task
.
Cancelables represent asynchronous units of work or other things scheduled for execution and whose execution can be canceled.
One use-case is the scheduling done by monix.execution.Scheduler, in which the scheduling methods return a
Cancelable
, allowing the canceling of the scheduling.Example: