Packages

final class CompositeCancelable extends BooleanCancelable

Represents a composite of multiple cancelables. In case it is canceled, all contained cancelables will be canceled too, e.g...

val s = CompositeCancelable()

s += c1
s += c2
s += c3

// c1, c2, c3 will also be canceled
s.cancel()

Additionally, once canceled, on appending of new cancelable references, those references will automatically get canceled too:

val s = CompositeCancelable()
s.cancel()

// c1 gets canceled, because s is already canceled
s += c1
// c2 gets canceled, because s is already canceled
s += c2

Adding and removing references from this composite is thread-safe.

Self Type
CompositeCancelable
Source
CompositeCancelable.scala
Linear Supertypes
BooleanCancelable, Cancelable, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CompositeCancelable
  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. def ++=(that: GenTraversableOnce[Cancelable]): CompositeCancelable.this.type

    Adds a collection of cancelables to this composite.

    Adds a collection of cancelables to this composite.

    If this composite is already canceled, then all the cancelables in the given collection will get canceled as well.

    Alias for addAll.

  4. def +=(other: Cancelable): CompositeCancelable.this.type

    Adds a cancelable reference to this composite.

    Adds a cancelable reference to this composite.

    If this composite is already canceled, then the given reference will be canceled as well.

    Alias for add.

  5. def --=(that: GenTraversableOnce[Cancelable]): CompositeCancelable.this.type

    Removes a collection of cancelables from this composite.

    Removes a collection of cancelables from this composite.

    By removing references from the composite, we ensure that the removed references don't get canceled when the composite gets canceled. Also useful for garbage collecting purposes.

    Alias for removeAll.

  6. def -=(s: Cancelable): CompositeCancelable.this.type

    Removes a cancelable reference from this composite.

    Removes a cancelable reference from this composite.

    By removing references from the composite, we ensure that the removed references don't get canceled when the composite gets canceled. Also useful for garbage collecting purposes.

    Alias for remove.

  7. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def add(other: Cancelable): CompositeCancelable.this.type

    Adds a cancelable reference to this composite.

    Adds a cancelable reference to this composite.

    If this composite is already canceled, then the given reference will be canceled as well.

    Annotations
    @tailrec()
  9. def addAll(that: GenTraversableOnce[Cancelable]): CompositeCancelable.this.type

    Adds a collection of cancelables to this composite.

    Adds a collection of cancelables to this composite.

    If this composite is already canceled, then all the cancelables in the given collection will get canceled as well.

  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. 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
    CompositeCancelable → Cancelable
    Annotations
    @tailrec()
  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def getAndSet(that: GenTraversableOnce[Cancelable]): Set[Cancelable]

    Replaces the underlying set of cancelables with a new one, returning the old set just before the substitution happened.

  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  19. def isCanceled: Boolean

    returns

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

    Definition Classes
    CompositeCancelable → BooleanCancelable
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  24. def remove(s: Cancelable): CompositeCancelable.this.type

    Removes a cancelable reference from this composite.

    Removes a cancelable reference from this composite.

    By removing references from the composite, we ensure that the removed references don't get canceled when the composite gets canceled. Also useful for garbage collecting purposes.

    Annotations
    @tailrec()
  25. def removeAll(that: GenTraversableOnce[Cancelable]): CompositeCancelable.this.type

    Removes a collection of cancelables from this composite.

    Removes a collection of cancelables from this composite.

    By removing references from the composite, we ensure that the removed references don't get canceled when the composite gets canceled. Also useful for garbage collecting purposes.

  26. def reset(): CompositeCancelable.this.type

    Resets this composite to an empty state, if not canceled, otherwise leaves it in the canceled state.

    Resets this composite to an empty state, if not canceled, otherwise leaves it in the canceled state.

    Annotations
    @tailrec()
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from BooleanCancelable

Inherited from Cancelable

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped