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.
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
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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
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
- StackedCancelable → Cancelable
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
isCanceled: Boolean
- returns
true in case this cancelable hasn't been canceled, or false otherwise.
- Definition Classes
- StackedCancelable → BooleanCancelable
-
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()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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.
- Annotations
- @tailrec()
-
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
- Annotations
- @tailrec()
-
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
- Annotations
- @tailrec()
-
def
push(value: Cancelable): Unit
Pushes a cancelable reference on the stack, to be popped or cancelled later in FIFO order.
Pushes a cancelable reference on the stack, to be popped or cancelled later in FIFO order.
- Annotations
- @tailrec()
-
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
- Annotations
- @tailrec()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
Deprecated Value Members
-
def
popAndCollapse(value: StackedCancelable): Cancelable
Deprecated, to be removed.
Deprecated, to be removed. Use popAndPushList instead.
- Annotations
- @deprecated
- Deprecated
(Since version v2.2.0) To be removed, use popAndPushAll instead
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.eval is for dealing with evaluation of results, thus exposing Task and Coeval.
monix.reactive exposes the
Observablepattern:Observableimplementationsmonix.types implements type-class shims, to be translated to type-classes provided by libraries such as Cats or Scalaz.
monix.cats is the optional integration with the Cats library, providing translations for the types described in
monix.types.monix.scalaz is the optional integration with the Scalaz library, providing translations for the types described in
monix.types.