sealed abstract 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.
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.
- Source
- StackedCancelable.scala
- Alphabetic
- By Inheritance
- StackedCancelable
- BooleanCancelable
- Cancelable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract 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
- Cancelable
- abstract def isCanceled: Boolean
- returns
true in case this cancelable hasn't been canceled, or false otherwise.
- Definition Classes
- BooleanCancelable
- abstract def pop(): Cancelable
Removes a cancelable reference from the stack in FIFO order.
Removes a cancelable reference from the stack in FIFO order.
- returns
the cancelable reference that was removed.
- abstract def popAndPush(value: Cancelable): Cancelable
Pops the head of the stack and pushes a list as an atomic operation.
Pops the head of the stack and pushes a list as an atomic operation.
This operation is the atomic equivalent of doing:
sc.pop() sc.push(value)
- value
is the cancelable reference to push on the stack
- returns
the cancelable reference that was popped from the stack
- abstract def popAndPushList(list: List[Cancelable]): Cancelable
Pops the head of the stack and pushes a list as an atomic operation.
Pops the head of the stack and pushes a list as an atomic operation.
This operation is the atomic equivalent of doing:
sc.pop() sc.pushList(list)
- list
is the list to prepend to the cancelable stack
- returns
the cancelable reference that was popped from the stack
- abstract def push(value: Cancelable): Unit
Pushes a cancelable reference on the stack, to be popped or cancelled later in FIFO order.
- abstract def pushList(list: List[Cancelable]): Unit
Pushes a whole list of cancelable references on the stack.
Pushes a whole list of cancelable references on the stack.
This operation is the atomic equivalent of doing:
for (c <- list.reverse) sc.push(c)
- list
is the list to prepend to the cancelable stack
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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.