CompositeCancelable

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.

Source: CompositeCancelable.scala

Linear Supertypes

BooleanCancelable, Cancelable, AnyRef, Any

Abstract Value Members

abstract def add(s: Cancelable): Unit

Adds a cancelable reference to this composite.
abstract def cancel(): Boolean

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 a single time. Implementations of this method should also be thread-safe.
returns
true if cancellation happened, or false if another execution happened previously or concurrently.

Definition Classes
Cancelable
abstract def isCanceled: Boolean

returns
true in case this cancelable hasn't been canceled.

Definition Classes
BooleanCancelable
abstract def remove(s: Cancelable): Unit

Removes a cancelable reference from this composite.

Concrete Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
final def +=(other: Cancelable): Unit

Adds a cancelable reference to this composite.
Adds a cancelable reference to this composite. This is an alias for add().
final def -=(s: Cancelable): Unit

Removes a cancelable reference from this composite.
Removes a cancelable reference from this composite. This is an alias for remove().
final def ==(arg0: Any): Boolean

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

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@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
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
@throws( ... )

Related Docs: object CompositeCancelable | package cancelables

trait CompositeCancelable extends BooleanCancelable

Abstract Value Members

abstract def add(s: Cancelable): Unit

abstract def cancel(): Boolean

abstract def isCanceled: Boolean

abstract def remove(s: Cancelable): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def +=(other: Cancelable): Unit

final def -=(s: Cancelable): Unit

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from BooleanCancelable

Inherited from Cancelable

Inherited from AnyRef

Inherited from Any

Ungrouped