Class/Object

monix.execution.cancelables

SerialCancelable

Related Docs: object SerialCancelable | package cancelables

Permalink

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.

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.

Source
SerialCancelable.scala
Linear Supertypes
Multi, Bool, BooleanCancelable, AssignableCancelable, Cancelable, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SerialCancelable
  2. Multi
  3. Bool
  4. BooleanCancelable
  5. AssignableCancelable
  6. Cancelable
  7. Serializable
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def :=(value: Cancelable): SerialCancelable.this.type

    Permalink

    Updates the internal reference of this assignable cancelable to the given value.

    Updates the internal reference of this assignable cancelable to the given value.

    If this cancelable is already canceled, then value is going to be canceled on assignment as well.

    returns

    this

    Definition Classes
    SerialCancelableAssignableCancelable
    Annotations
    @tailrec()
  4. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  6. 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
    SerialCancelableCancelable
  7. def clone(): AnyRef

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def isCanceled: Boolean

    Permalink

    returns

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

    Definition Classes
    SerialCancelableBooleanCancelable
  14. final def isInstanceOf[T0]: Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef
  18. def orderedUpdate(value: Cancelable, order: Long): SerialCancelable.this.type

    Permalink

    An ordered update is an update with an order attached and if the currently stored reference has on order that is greater than the update, then the update is ignored.

    An ordered update is an update with an order attached and if the currently stored reference has on order that is greater than the update, then the update is ignored.

    Definition Classes
    SerialCancelableMulti
    Annotations
    @tailrec()
  19. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

Inherited from Multi

Inherited from Bool

Inherited from BooleanCancelable

Inherited from AssignableCancelable

Inherited from Cancelable

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped