Packages

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
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StackedCancelable
  2. BooleanCancelable
  3. Cancelable
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. 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
    StackedCancelableCancelable
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  12. def isCanceled: Boolean

    returns

    true in case this cancelable hasn't been canceled, or false otherwise.

    Definition Classes
    StackedCancelableBooleanCancelable
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  17. 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()
  18. 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()
  19. 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()
  20. 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()
  21. 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()
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. 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

Inherited from BooleanCancelable

Inherited from Cancelable

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped