object CancelableFuture extends CancelableFutureForPlatform with Serializable
- Source
- CancelableFuture.scala
- Alphabetic
- By Inheritance
- CancelableFuture
- Serializable
- CancelableFutureForPlatform
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply[A](underlying: Future[A], cancelable: Cancelable): CancelableFuture[A]
Builder for a CancelableFuture.
Builder for a CancelableFuture.
- underlying
is an underlying
Futurereference that will respond toonCompletecalls- cancelable
is a Cancelable that can be used to cancel the active computation
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
registrationfunction 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.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def failed[A](e: Throwable): CancelableFuture[A]
Promotes a strict
Throwableto a CancelableFuture that's already complete with a failure.Promotes a strict
Throwableto a CancelableFuture that's already complete with a failure.- e
is the error that's going to be signaled in the
onCompletecallback.
- def fromJavaCompletable[A](cfa: CompletableFuture[A])(implicit ec: ExecutionContext): CancelableFuture[A]
Convert
java.util.concurrent.CompletableFutureto CancelableFutureConvert
java.util.concurrent.CompletableFutureto CancelableFutureIf the source is cancelled, returned
Futurewill never terminate- Definition Classes
- CancelableFutureForPlatform
- 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 theonCompletecallback.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def never[A]: CancelableFuture[A]
Returns a CancelableFuture instance that will never complete.
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def pure[A](value: A): CancelableFuture[A]
Promotes a strict
valueto a CancelableFuture that's already complete.Promotes a strict
valueto a CancelableFuture that's already complete.Alias for successful.
- value
is the value that's going to be signaled in the
onCompletecallback.
- def raiseError[A](e: Throwable): CancelableFuture[A]
Promotes a strict
Throwableto a CancelableFuture that's already complete with a failure.Promotes a strict
Throwableto a CancelableFuture that's already complete with a failure.Alias for failed.
- e
is the error that's going to be signaled in the
onCompletecallback.
- def successful[A](value: A): CancelableFuture[A]
Promotes a strict
valueto a CancelableFuture that's already complete.Promotes a strict
valueto a CancelableFuture that's already complete.- value
is the value that's going to be signaled in the
onCompletecallback.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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
- def toString(): String
- Definition Classes
- AnyRef → Any
- val unit: CancelableFuture[Unit]
An already completed CancelableFuture.
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
This is the API documentation for the Monix library.
Package Overview
monix.execution exposes lower level primitives for dealing with asynchronous execution:
Atomictypes, as alternative tojava.util.concurrent.atomicmonix.catnap exposes pure abstractions built on top of the Cats-Effect type classes:
monix.eval is for dealing with evaluation of results, thus exposing Task and Coeval.
monix.reactive exposes the
Observablepattern:Observableimplementationsmonix.tail exposes Iterant for purely functional pull based streaming:
BatchandBatchCursor, the alternatives to Scala'sIterableandIteratorrespectively that we are using within Iterant's encodingYou can control evaluation with type you choose - be it Task, Coeval, cats.effect.IO or your own as long as you provide correct cats-effect or cats typeclass instance.