Class/Object

monix.execution.cancelables

StackedCancelable

Related Docs: object StackedCancelable | package cancelables

Permalink

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.

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

Abstract Value Members

  1. abstract def cancel(): Unit

    Permalink

    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
  2. abstract def isCanceled: Boolean

    Permalink

    returns

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

    Definition Classes
    BooleanCancelable
  3. abstract def pop(): Cancelable

    Permalink

    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.

  4. abstract def popAndPush(value: Cancelable): Cancelable

    Permalink

    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

  5. abstract def popAndPushList(list: List[Cancelable]): Cancelable

    Permalink

    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

  6. abstract def push(value: Cancelable): Unit

    Permalink

    Pushes a cancelable reference on the stack, to be popped or cancelled later in FIFO order.

  7. abstract def pushList(list: List[Cancelable]): Unit

    Permalink

    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

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from BooleanCancelable

Inherited from Cancelable

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped