CopperSpice API
1.9.2
|
The QFutureSynchronizer class simplifies QFuture synchronization. More...
Public Methods | |
QFutureSynchronizer () | |
QFutureSynchronizer (const QFuture< T > &future) | |
~QFutureSynchronizer () | |
void | addFuture (const QFuture< T > &future) |
bool | cancelOnWait () const |
void | clearFutures () |
QList< QFuture< T > > | futures () const |
void | setCancelOnWait (bool enabled) |
void | setFuture (const QFuture< T > &future) |
void | waitForFinished () |
The QFutureSynchronizer class simplifies QFuture synchronization. This is templated class which synchronizes with one or more QFuture objects. Futures are added using the addFuture() or setFuture() functions. The futures() method returns a list of futures. Use clearFutures() to remove all futures from the QFutureSynchronizer.
The waitForFinished() method waits for all futures to finish. The destructor of QFutureSynchronizer calls waitForFinished(), providing an easy way to ensure that all futures have finished before returning from a function.
The behavior of waitForFinished() can be changed using the setCancelOnWait() function. Calling setCancelOnWait(true) will cause waitForFinished() to cancel all futures before waiting for them to finish. You can query the status of the cancel-on-wait feature using the cancelOnWait() function.
|
inline |
Constructs a QFutureSynchronizer.
|
inlineexplicit |
Constructs a QFutureSynchronizer and begins watching future by calling addFuture().
|
inline |
Calls waitForFinished() function to ensure that all futures have finished before destroying this QFutureSynchronizer.
|
inline |
Adds future to the list of managed futures.
|
inline |
Returns true if the cancel-on-wait feature is enabled, otherwise returns false. If cancel-on-wait is enabled, the waitForFinished() function will cancel all futures before waiting for them to finish.
|
inline |
Removes all managed futures from this QFutureSynchronizer.
Returns a list of all managed futures.
|
inline |
Enables or disables the cancel-on-wait feature based on the enabled argument. If enabled is true,the waitForFinished() function will cancel all futures before waiting for them to finish.
|
inline |
Sets future to be the only future managed by this QFutureSynchronizer. This method calls waitForFinished(), clearFutures(), and finally passes the given future to addFuture().
|
inline |
Waits for all futures to finish. If cancelOnWait() returns true, each future is canceled before waiting for them to finish.