decaf::util::concurrent::FutureType Class Reference
#include <src/main/decaf/util/concurrent/Future.h>
Public Member Functions | |
| virtual | ~FutureType () |
| virtual bool | cancel (bool mayInterruptIfRunning)=0 |
| Attempts to cancel execution of this task. | |
| virtual bool | isCancelled () const =0 |
| Returns true if this task was canceled before it completed normally. | |
| virtual bool | isDone () const =0 |
| Returns true if this task completed. | |
Constructor & Destructor Documentation
| virtual decaf::util::concurrent::FutureType::~FutureType | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual bool decaf::util::concurrent::FutureType::cancel | ( | bool | mayInterruptIfRunning | ) | [pure virtual] |
Attempts to cancel execution of this task.
This attempt will fail if the task has already completed, has already been canceled, or could not be canceled for some other reason. If successful, and this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task should be interrupted in an attempt to stop the task.
After this method returns, subsequent calls to isDone() will always return true. Subsequent calls to isCancelled() will always return true if this method returned true.
- Parameters:
-
mayInterruptIfRunning True if the thread executing this task should be interrupted; otherwise, in-progress tasks are allowed to complete.
- Returns:
- false if the task could not be canceled, typically because it has already completed normally; true otherwise
Implemented in decaf::util::concurrent::FutureTask< T >.
| virtual bool decaf::util::concurrent::FutureType::isCancelled | ( | ) | const [pure virtual] |
Returns true if this task was canceled before it completed normally.
- Returns:
- true if this task was canceled before it completed
Implemented in decaf::util::concurrent::FutureTask< T >.
| virtual bool decaf::util::concurrent::FutureType::isDone | ( | ) | const [pure virtual] |
Returns true if this task completed.
Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true.
- Returns:
- true if this task completed
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
