A DispatchGroup is a group of QRunnables dispatched on queues. More...
#include <QtDispatch/qdispatchgroup.h>
Inheritance diagram for QDispatchGroup:Public Slots | |
| void | resume () |
| Resumes the invocation of operations or blocks assigned to the object. | |
| void | suspend () |
| Suspends the invocation of operations or blocks assigned to the object. | |
Signals | |
| void | allFinished () |
| This will be emitted additionally to any function or block submitted via notify(). | |
Public Member Functions | |
| QDispatchGroup () | |
| Creates a new QDispatchGroup. | |
| QDispatchGroup (dispatch_group_t) | |
| QDispatchGroup (const QDispatchGroup &) | |
| QDispatchGroup (const xdispatch::group &) | |
| ~QDispatchGroup () | |
| void | async (QRunnable *r, const xdispatch::queue &q=xdispatch::global_queue()) |
| Dispatches a Runnable on the given Queue. | |
| bool | wait (const QTime &t) |
| Waits until the given time has passed or all dispatched runnables in the group were executed. | |
| void | notify (QRunnable *r, const xdispatch::queue &=xdispatch::global_queue()) |
| This function schedules a notification runnable to be submitted to the specified queue once all runnables associated with the dispatch group have completed. | |
| void | notify (xdispatch::operation *, const xdispatch::queue &=xdispatch::global_queue()) |
| void | notify (dispatch_block_t b, const xdispatch::queue &q=xdispatch::global_queue()) |
| void | enableAllFinishedSignal () |
| Activates the allFinished() signal or this QDispatchGroup. | |
| void | async (operation *r, const queue &q=global_queue()) |
| Dispatches an operation on the given Queue. | |
| void | async (dispatch_block_t b, const queue &q=global_queue()) |
| Same as dispatch(operation* r, ...) Will wrap the given block in an operation and put it on the queue. | |
| bool | wait (dispatch_time_t t=DISPATCH_TIME_FOREVER) |
| Waits until the given time has passed or all dispatched operations in the group were executed. | |
| bool | wait (struct tm *timeout) |
| Waits until the given time has passed or all dispatched operations in the group were executed. | |
| virtual dispatch_object_t | native () const |
| dispatch_group_t | native_group () const |
| virtual void | target_queue (const queue &) |
| Sets the target queue of this object, i.e. | |
| bool | operator== (const object &) |
| bool | operator== (const dispatch_object_t &) |
| bool | operator!= (const object &) |
| bool | operator!= (const dispatch_object_t &) |
Friends | |
| Q_DECL_EXPORT QDebug | operator<< (QDebug, const QDispatchGroup &) |
A DispatchGroup is a group of QRunnables dispatched on queues.
This class provides a way to track all these QRunnables and notify you if all of them finished executing.
See also Apple's Documentation of Dispatch Groups
Definition at line 56 of file qdispatchgroup.h.
Creates a new QDispatchGroup.
| QDispatchGroup::QDispatchGroup | ( | const QDispatchGroup & | ) |
| QDispatchGroup::QDispatchGroup | ( | const xdispatch::group & | ) |
| void QDispatchGroup::allFinished | ( | ) | [signal] |
This will be emitted additionally to any function or block submitted via notify().
Every time the all work dispatched to the group (i.e. the group is empty) this signal will be emitted.
| void xdispatch::group::async | ( | operation * | r, |
| const queue & | q = global_queue() |
||
| ) | [inherited] |
Dispatches an operation on the given Queue.
| r | The operation to be dispatched |
| q | The Queue to use. If no Queue is given, the system default queue will be used |
| void xdispatch::group::async | ( | dispatch_block_t | b, |
| const queue & | q = global_queue() |
||
| ) | [inline, inherited] |
| void QDispatchGroup::async | ( | QRunnable * | r, |
| const xdispatch::queue & | q = xdispatch::global_queue() |
||
| ) |
Dispatches a Runnable on the given Queue.
| r | The QRunnable to be dispatched |
| q | The Queue to use. If no Queue is given, the system default queue will be used |
Activates the allFinished() signal or this QDispatchGroup.
Needs to be called everytime all scheduled work on the group finished and new work was submitted which was not finished yet.
Note: All installed notification handlers will be disabled and all other QDispatchGroup objects working on the same group will stop to emit the signal, i.e. only one QDispatchGroup object can emit the signal at a time.
Note2: When assigning a new notification handler by using notify() the signal of this object will be enabled by default
| virtual dispatch_object_t xdispatch::group::native | ( | ) | const [virtual, inherited] |
Implements xdispatch::object.
| dispatch_group_t xdispatch::group::native_group | ( | ) | const [inherited] |
| void QDispatchGroup::notify | ( | QRunnable * | r, |
| const xdispatch::queue & | = xdispatch::global_queue() |
||
| ) |
This function schedules a notification runnable to be submitted to the specified queue once all runnables associated with the dispatch group have completed.
If no runnables are associated with the dispatch group (i.e. the group is empty) then the notification runnable will be submitted immediately.
The runnable will be empty at the time the notification block is submitted to the target queue. The group may either be deleted or reused for additional operations.
| void QDispatchGroup::notify | ( | xdispatch::operation * | , |
| const xdispatch::queue & | = xdispatch::global_queue() |
||
| ) |
Reimplemented from xdispatch::group.
| void QDispatchGroup::notify | ( | dispatch_block_t | b, |
| const xdispatch::queue & | q = xdispatch::global_queue() |
||
| ) | [inline] |
Reimplemented from xdispatch::group.
Definition at line 106 of file qdispatchgroup.h.
| bool xdispatch::object::operator!= | ( | const object & | ) | [inherited] |
| bool xdispatch::object::operator!= | ( | const dispatch_object_t & | ) | [inherited] |
| bool xdispatch::object::operator== | ( | const object & | ) | [inherited] |
| bool xdispatch::object::operator== | ( | const dispatch_object_t & | ) | [inherited] |
| void QDispatchGroup::resume | ( | ) | [virtual, slot] |
Resumes the invocation of operations or blocks assigned to the object.
Reimplemented from xdispatch::object.
| void QDispatchGroup::suspend | ( | ) | [virtual, slot] |
Suspends the invocation of operations or blocks assigned to the object.
The object will be suspended as soon as the currently executed operation or block finished.
Reimplemented from xdispatch::object.
| virtual void xdispatch::object::target_queue | ( | const queue & | ) | [virtual, inherited] |
Sets the target queue of this object, i.e.
the queue all items concerning this object will be dispatched on in turn.
Reimplemented in xdispatch::source.
| bool xdispatch::group::wait | ( | dispatch_time_t | t = DISPATCH_TIME_FOREVER | ) | [inherited] |
Waits until the given time has passed or all dispatched operations in the group were executed.
| t | give a time here or a DISPATCH_TIME_FOREVER to wait until all operations are done |
| bool QDispatchGroup::wait | ( | const QTime & | t | ) |
Waits until the given time has passed or all dispatched runnables in the group were executed.
| t | give a timeout here or a QTime of zero to wait until all runnables are done |
| bool xdispatch::group::wait | ( | struct tm * | timeout | ) | [inherited] |
Waits until the given time has passed or all dispatched operations in the group were executed.
| timeout | give a timeout here |
| Q_DECL_EXPORT QDebug operator<< | ( | QDebug | , |
| const QDispatchGroup & | |||
| ) | [friend] |
