diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2022-03-15 08:14:51 +0100 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2022-03-16 07:59:29 +0100 |
| commit | 8fb276b5d8436e2ec84e1b9d3f24a77fb2863017 (patch) | |
| tree | 2edd6065bf1685ee28830ceccccd1feaf78ead83 /sources/pyside6/doc/extras/QtConcurrent.rst | |
| parent | 8b79b1ce2cb0353c85919600a1ff269e56a537e6 (diff) | |
PySide6/Documentation: Add module descriptions
Add module descriptions and a README.md on how to create them.
Pick-to: 6.2
Change-Id: I627205843bedd74e625d14da718e42faac0a2c68
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6/doc/extras/QtConcurrent.rst')
| -rw-r--r-- | sources/pyside6/doc/extras/QtConcurrent.rst | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/sources/pyside6/doc/extras/QtConcurrent.rst b/sources/pyside6/doc/extras/QtConcurrent.rst new file mode 100644 index 000000000..33c5b3bfb --- /dev/null +++ b/sources/pyside6/doc/extras/QtConcurrent.rst @@ -0,0 +1,37 @@ +The Qt Concurrent module contains functionality to support concurrent execution +of program code. + +The Qt Concurrent module provides high-level APIs that make it possible to +write multi-threaded programs without using low-level threading primitives such +as mutexes, read-write locks, wait conditions, or semaphores. Programs written +with Qt Concurrent automatically adjust the number of threads used according to +the number of processor cores available. This means that applications written +today will continue to scale when deployed on multi-core systems in the future. + +Qt Concurrent includes functional programming style APIs for parallel list +processing, including a MapReduce and FilterReduce implementation for +shared-memory (non-distributed) systems, and classes for managing asynchronous +computations in GUI applications: + + * :class:`QFuture<PySide6.QtCore.QFuture>` represents the result of an + asynchronous computation. + * :class:`QFutureIterator<~.QFutureIterator>` allows iterating through results + available via :class:`QFuture<PySide6.QtCore.QFuture>` . + * :class:`QFutureWatcher<PySide6.QtCore.QFutureWatcher>` allows monitoring a + :class:`QFuture<PySide6.QtCore.QFuture>` using signals-and-slots. + * :class:`QFutureSynchronizer<~.QFutureSynchronizer>` is a convenience class + that automatically synchronizes several QFutures. + * :class:`QPromise<~.QPromise>` provides a way to report progress and results + of the asynchronous computation to :class:`QFuture<PySide6.QtCore.QFuture>` . + Allows suspending or canceling the task when requested by + :class:`QFuture<PySide6.QtCore.QFuture>` . + +Using the Module +^^^^^^^^^^^^^^^^ + +To include the definitions of modules classes, use the following +directive: + +:: + + import PySide6.QtConcurrent |