decaf::util::concurrent::Future< V > Class Template Reference
A Future represents the result of an asynchronous computation. More...
#include <src/main/decaf/util/concurrent/Future.h>
Public Member Functions | |
| virtual | ~Future () |
| virtual V | get ()=0 |
| Waits if necessary for the computation to complete, and then retrieves its result. | |
| virtual V | get (long long timeout, const TimeUnit &unit)=0 |
| Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available. | |
Detailed Description
template<typename V>
class decaf::util::concurrent::Future< V >
A Future represents the result of an asynchronous computation.
Methods are provided to check if the computation is complete, to wait for its completion, and to retrieve the result of the computation. The result can only be retrieved using method get when the computation has completed, blocking if necessary until it is ready. Cancellation is performed by the cancel method. Additional methods are provided to determine if the task completed normally or was canceled. Once a computation has completed, the computation cannot be canceled. If you would like to use a Future for the sake of cancellability but not provide a usable result, you can declare types of the form Future<void*> and return null as a result of the underlying task.
- Since:
- 1.0
Constructor & Destructor Documentation
| virtual decaf::util::concurrent::Future< V >::~Future | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual V decaf::util::concurrent::Future< V >::get | ( | long long | timeout, | |
| const TimeUnit & | unit | |||
| ) | [pure virtual] |
Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
- Parameters:
-
timeout The maximum time to wait for this Future to finish. unit The time unit of the timeout argument.
- Returns:
- the computed result
- Exceptions:
-
CancellationException if the computation was canceled ExecutionException if the computation threw an exception InterruptedException if the current thread was interrupted while waiting TimeoutException if the wait timed out before the future completed.
Implemented in decaf::util::concurrent::FutureTask< T >.
| virtual V decaf::util::concurrent::Future< V >::get | ( | ) | [pure virtual] |
Waits if necessary for the computation to complete, and then retrieves its result.
- Returns:
- the computed result.
- Exceptions:
-
CancellationException if the computation was canceled ExecutionException if the computation threw an exception InterruptedException if the current thread was interrupted while waiting
Implemented in decaf::util::concurrent::FutureTask< T >.
The documentation for this class was generated from the following file:
- src/main/decaf/util/concurrent/Future.h
