object CancelableFuture extends CancelableFutureForPlatform with Serializable
- Alphabetic
- By Inheritance
- CancelableFuture
- Serializable
- Serializable
- CancelableFutureForPlatform
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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
Future
reference that will respond toonComplete
calls- 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
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.
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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.
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
fromJavaCompletable[A](cfa: CompletableFuture[A])(implicit ec: ExecutionContext): CancelableFuture[A]
Convert
java.util.concurrent.CompletableFuture
to CancelableFutureConvert
java.util.concurrent.CompletableFuture
to CancelableFutureIf the source is cancelled, returned
Future
will 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 theonComplete
callback.
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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.
-
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.
-
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.
-
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(): 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
- @native() @throws( ... )