Add QPromise<T>::timeout documentation

This commit is contained in:
Simon Brunel 2018-02-17 12:59:05 +01:00
parent 4af2740d80
commit 9d2a4ca00f
3 changed files with 20 additions and 0 deletions

View File

@ -12,6 +12,7 @@
* [.isRejected](qtpromise/qpromise/isrejected.md) * [.isRejected](qtpromise/qpromise/isrejected.md)
* [.tap](qtpromise/qpromise/tap.md) * [.tap](qtpromise/qpromise/tap.md)
* [.then](qtpromise/qpromise/then.md) * [.then](qtpromise/qpromise/then.md)
* [.timeout](qtpromise/qpromise/timeout.md)
* [.wait](qtpromise/qpromise/wait.md) * [.wait](qtpromise/qpromise/wait.md)
* [::all (static)](qtpromise/qpromise/all.md) * [::all (static)](qtpromise/qpromise/all.md)
* [::reject (static)](qtpromise/qpromise/reject.md) * [::reject (static)](qtpromise/qpromise/reject.md)

View File

@ -11,6 +11,7 @@
* [`QPromise<T>::isRejected`](qpromise/isrejected.md) * [`QPromise<T>::isRejected`](qpromise/isrejected.md)
* [`QPromise<T>::tap`](qpromise/tap.md) * [`QPromise<T>::tap`](qpromise/tap.md)
* [`QPromise<T>::then`](qpromise/then.md) * [`QPromise<T>::then`](qpromise/then.md)
* [`QPromise<T>::timeout`](qpromise/timeout.md)
* [`QPromise<T>::wait`](qpromise/wait.md) * [`QPromise<T>::wait`](qpromise/wait.md)
### Public Static Members ### Public Static Members

View File

@ -0,0 +1,18 @@
## `QPromise<T>::timeout`
```
QPromise<T>::timeout(int msec, any error = QPromiseTimeoutException) -> QPromise<T>
```
This method returns a promise that will be resolved with the `input` promise's fulfillment value or rejection reason. However, if the `input` promise is not fulfilled or rejected within `msec` milliseconds, the `output` promise is rejected with `error` as the reason (`QPromiseTimeoutException` by default).
```cpp
QPromise<int> input = {...}
auto output = input.timeout(2000)
.then([](int res) {
// operation succeeded within 2 seconds
})
.fail([](const QPromiseTimeoutException& e) {
// operation timed out!
});
```