Package

monix.execution

cancelables

Permalink

package cancelables

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:

val s = ConcurrentScheduler()
val task = s.scheduleRepeated(10.seconds, 50.seconds, {
  doSomething()
})

// later, cancels the scheduling ...
task.cancel()

Source: package.scala

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

cancelables
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

trait AssignableCancelable extends Cancelable

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.
trait BooleanCancelable extends Cancelable

Represents a Cancelable that can be queried for the canceled status.
final class CompositeCancelable extends BooleanCancelable

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.
final class MultiAssignmentCancelable extends Multi

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.
final class RefCountCancelable extends BooleanCancelable

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:
- cancel both children
- cancel the main RefCountCancelable
The implementation is thread-safe and cancellation order doesn't matter.
final class SerialCancelable extends Multi

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.
final class SingleAssignmentCancelable extends Bool

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.
final class StackedCancelable extends BooleanCancelable

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.

Value Members

object AssignableCancelable extends Serializable
object BooleanCancelable extends Serializable
object CompositeCancelable extends Serializable
object MultiAssignmentCancelable extends Serializable
object RefCountCancelable extends Serializable
object SerialCancelable extends Serializable
object SingleAssignmentCancelable extends Serializable
object StackedCancelable extends Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped