trait FutureAction[T] extends Future[T]
A future for the result of an action to support cancellation. This is an extension of the Scala Future interface to support cancellation.
- Source
- FutureAction.scala
- Alphabetic
- By Inheritance
- FutureAction
- Future
- Awaitable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
cancel(): Unit
Cancels the execution of this action.
-
abstract
def
isCancelled: Boolean
Returns whether the action has been cancelled.
-
abstract
def
isCompleted: Boolean
Returns whether the action has already been completed with a value or an exception.
Returns whether the action has already been completed with a value or an exception.
- Definition Classes
- FutureAction → Future
-
abstract
def
jobIds: Seq[Int]
Returns the job IDs run by the underlying async operation.
Returns the job IDs run by the underlying async operation.
This returns the current snapshot of the job list. Certain operations may run multiple jobs, so multiple calls to this method may return different lists.
-
abstract
def
onComplete[U](func: (Try[T]) ⇒ U)(implicit executor: ExecutionContext): Unit
When this action is completed, either through an exception, or a value, applies the provided function.
When this action is completed, either through an exception, or a value, applies the provided function.
- Definition Classes
- FutureAction → Future
-
abstract
def
ready(atMost: Duration)(implicit permit: CanAwait): FutureAction.this.type
Blocks until this action completes.
Blocks until this action completes.
- atMost
maximum wait time, which may be negative (no waiting is done), Duration.Inf for unbounded waiting, or a finite positive duration
- returns
this FutureAction
- Definition Classes
- FutureAction → Awaitable
-
abstract
def
result(atMost: Duration)(implicit permit: CanAwait): T
Awaits and returns the result (of type T) of this action.
Awaits and returns the result (of type T) of this action.
- atMost
maximum wait time, which may be negative (no waiting is done), Duration.Inf for unbounded waiting, or a finite positive duration
- returns
the result value if the action is completed within the specific maximum wait time
- Definition Classes
- FutureAction → Awaitable
- Annotations
- @throws( classOf[Exception] )
- Exceptions thrown
Exception
exception during action execution
-
abstract
def
transform[S](f: (Try[T]) ⇒ Try[S])(implicit executor: ExecutionContext): Future[S]
- Definition Classes
- Future
-
abstract
def
transformWith[S](f: (Try[T]) ⇒ Future[S])(implicit executor: ExecutionContext): Future[S]
- Definition Classes
- Future
-
abstract
def
value: Option[Try[T]]
The value of this Future.
The value of this Future.
If the future is not completed the returned value will be None. If the future is completed the value will be Some(Success(t)) if it contains a valid result, or Some(Failure(error)) if it contains an exception.
- Definition Classes
- FutureAction → Future
Concrete Value Members
-
def
andThen[U](pf: PartialFunction[Try[T], U])(implicit executor: ExecutionContext): Future[T]
- Definition Classes
- Future
-
def
collect[S](pf: PartialFunction[T, S])(implicit executor: ExecutionContext): Future[S]
- Definition Classes
- Future
-
def
failed: Future[Throwable]
- Definition Classes
- Future
-
def
fallbackTo[U >: T](that: Future[U]): Future[U]
- Definition Classes
- Future
-
def
filter(p: (T) ⇒ Boolean)(implicit executor: ExecutionContext): Future[T]
- Definition Classes
- Future
-
def
flatMap[S](f: (T) ⇒ Future[S])(implicit executor: ExecutionContext): Future[S]
- Definition Classes
- Future
-
def
flatten[S](implicit ev: <:<[T, Future[S]]): Future[S]
- Definition Classes
- Future
-
def
foreach[U](f: (T) ⇒ U)(implicit executor: ExecutionContext): Unit
- Definition Classes
- Future
-
def
get(): T
Blocks and returns the result of this job.
Blocks and returns the result of this job.
- Annotations
- @throws( classOf[SparkException] )
-
def
map[S](f: (T) ⇒ S)(implicit executor: ExecutionContext): Future[S]
- Definition Classes
- Future
-
def
mapTo[S](implicit tag: ClassTag[S]): Future[S]
- Definition Classes
- Future
-
def
recover[U >: T](pf: PartialFunction[Throwable, U])(implicit executor: ExecutionContext): Future[U]
- Definition Classes
- Future
-
def
recoverWith[U >: T](pf: PartialFunction[Throwable, Future[U]])(implicit executor: ExecutionContext): Future[U]
- Definition Classes
- Future
-
def
transform[S](s: (T) ⇒ S, f: (Throwable) ⇒ Throwable)(implicit executor: ExecutionContext): Future[S]
- Definition Classes
- Future
-
final
def
withFilter(p: (T) ⇒ Boolean)(implicit executor: ExecutionContext): Future[T]
- Definition Classes
- Future
-
def
zip[U](that: Future[U]): Future[(T, U)]
- Definition Classes
- Future
-
def
zipWith[U, R](that: Future[U])(f: (T, U) ⇒ R)(implicit executor: ExecutionContext): Future[R]
- Definition Classes
- Future
Deprecated Value Members
-
def
onFailure[U](pf: PartialFunction[Throwable, U])(implicit executor: ExecutionContext): Unit
- Definition Classes
- Future
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.0) use
onComplete
orfailed.foreach
instead (keep in mind that they take total rather than partial functions)
-
def
onSuccess[U](pf: PartialFunction[T, U])(implicit executor: ExecutionContext): Unit
- Definition Classes
- Future
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.0) use
foreach
oronComplete
instead (keep in mind that they take total rather than partial functions)