Packages

object CancelableFuture extends CancelableFutureForPlatform with Serializable

Source
CancelableFuture.scala
Linear Supertypes
Serializable, Serializable, CancelableFutureForPlatform, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CancelableFuture
  2. Serializable
  3. Serializable
  4. CancelableFutureForPlatform
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final class CatsInstances extends Monad[CancelableFuture] with StackSafeMonad[CancelableFuture] with CoflatMap[CancelableFuture] with MonadError[CancelableFuture, Throwable]

    Implementation of Cats type classes for the CancelableFuture data type.

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. def apply[A](underlying: Future[A], cancelable: Cancelable): CancelableFuture[A]

    Builder for a CancelableFuture.

    Builder for a CancelableFuture.

    underlying

    is an underlying Future reference that will respond to onComplete calls

    cancelable

    is a Cancelable that can be used to cancel the active computation

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def async[A](register: ((Try[A]) ⇒ Unit) ⇒ Cancelable)(implicit ec: ExecutionContext): CancelableFuture[A]

    Given a registration function that can execute an asynchronous process, executes it and builds a CancelableFuture value out of it.

    Given a registration function that can execute an asynchronous process, executes it and builds a CancelableFuture value out of it.

    The given registration function can return a Cancelable reference that can be used to cancel the executed async process. This reference can be empty.

    def delayedResult[A](f: => A)(implicit s: Scheduler): CancelableFuture[A] =
      CancelableFuture.async { complete =>
        val task = s.scheduleOnce(10.seconds) { complete(Try(f)) }
    
        Cancelable { () =>
          println("Cancelling!")
          task.cancel()
        }
      }

    This is much like working with Scala's Promise, only safer.

  7. implicit def catsInstances(implicit ec: ExecutionContext): CatsInstances

    Returns the associated Cats type class instances for the CancelableFuture data type.

    Returns the associated Cats type class instances for the CancelableFuture data type.

    ec

    is the ExecutionContext needed in order to create the needed type class instances, since future transformations rely on an ExecutionContext passed explicitly (by means of an implicit parameter) on each operation

  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def failed[A](e: Throwable): CancelableFuture[A]

    Promotes a strict Throwable to a CancelableFuture that's already complete with a failure.

    Promotes a strict Throwable to a CancelableFuture that's already complete with a failure.

    e

    is the error that's going to be signaled in the onComplete callback.

  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def fromJavaCompletable[A](cfa: CompletableFuture[A])(implicit ec: ExecutionContext): CancelableFuture[A]

    Convert java.util.concurrent.CompletableFuture to CancelableFuture

    Convert java.util.concurrent.CompletableFuture to CancelableFuture

    If the source is cancelled, returned Future will never terminate

    Definition Classes
    CancelableFutureForPlatform
  14. def fromTry[A](value: Try[A]): CancelableFuture[A]

    Promotes a strict Try[A] to a CancelableFuture that's already complete.

    Promotes a strict Try[A] to a CancelableFuture that's already complete.

    value

    is the Try[A] value that's going to be signaled in the onComplete callback.

  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def never[A]: CancelableFuture[A]

    Returns a CancelableFuture instance that will never complete.

  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def pure[A](value: A): CancelableFuture[A]

    Promotes a strict value to a CancelableFuture that's already complete.

    Promotes a strict value to a CancelableFuture that's already complete.

    Alias for successful.

    value

    is the value that's going to be signaled in the onComplete callback.

  23. def raiseError[A](e: Throwable): CancelableFuture[A]

    Promotes a strict Throwable to a CancelableFuture that's already complete with a failure.

    Promotes a strict Throwable to a CancelableFuture that's already complete with a failure.

    Alias for failed.

    e

    is the error that's going to be signaled in the onComplete callback.

  24. def successful[A](value: A): CancelableFuture[A]

    Promotes a strict value to a CancelableFuture that's already complete.

    Promotes a strict value to a CancelableFuture that's already complete.

    value

    is the value that's going to be signaled in the onComplete callback.

  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toJavaCompletable[A](source: CancelableFuture[A])(implicit ec: ExecutionContext): CompletableFuture[A]

    Convert CancelableFuture to java.util.concurrent.CompletableFuture.

    Convert CancelableFuture to java.util.concurrent.CompletableFuture.

    Definition Classes
    CancelableFutureForPlatform
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. val unit: CancelableFuture[Unit]

    An already completed CancelableFuture.

  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
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from CancelableFutureForPlatform

Inherited from AnyRef

Inherited from Any

Ungrouped