qcoro
v0.11.0
Библиотека QCoro предоставляет набор инструментов для использования сопрограмм C++20 с Qt.
Взгляните на пример ниже, чтобы увидеть, насколько удивительной вещью являются сопрограммы:
QNetworkAccessManager networkAccessManager;// co_await ответа — сопрограмма приостанавливается до тех пор, пока не завершится QNetworkReply.// Пока сопрограмма приостановлена, *цикл событий Qt выполняется как обычно*.const QNetworkReply *reply = co_await networkAccessManager.get(url); // Как только ответ будет готов, ваш код продолжит работу здесь, как будто ничего удивительного не произошло ;-)const auto data = ответ->readAll();
Для этого требуется компилятор с поддержкой сопрограмм TS, список поддерживаемых компиляторов и версий см. в документации.
Документация
QCoro предоставляет инструменты, необходимые для простого использования сопрограмм C++20 с Qt. Краеугольным камнем библиотеки является QCoro::Task<T> , который представляет выполняемую сопрограмму и позволяет асинхронно ожидать результата сопрограммы вызывающей стороне. Кроме того, QCoro предоставляет набор оболочек для распространенных типов Qt, таких как QTimer , QNetworkReply , QDBusPendingCall , QFuture и других, которые позволяют напрямую совместно co_await их асинхронных операций.
Кроме того, существует волшебная функция qCoro() , которая может обертывать многие собственные функции и типы Qt, чтобы сделать их удобными для сопрограмм.
Проверьте документацию, чтобы получить полный список всех поддерживаемых функций и типов Qt.
QDBusPendingCall QCoro может дождаться завершения асинхронного вызова D-Bus. Нет необходимости использовать QDBusPendingCallWatcher с QCoro — вместо этого просто co_await результата. Во время co_awaiting цикл событий Qt работает как обычно.
QDBusInterface RemoteServiceInterface{serviceName, objectPath, интерфейс};const QDBusReply<bool> isReady = co_await RemoteServiceInterface.asyncCall(QStringLiteral("isReady"));Полная документация здесь.
QFuture QFuture представляет собой результат асинхронной задачи. Обычно вам приходится использовать QFutureWatcher , чтобы получать уведомления о том, что будущее готово. С QCoro вы можете просто co_await !
const QFuture<int> Task1 = QtConcurrent::run(....);const QFuture<int> Task2 = QtConcurrent::run(....);const int a = co_await Task1;const int b = co_await Task2; co_return а + б;
Полная документация здесь.
QNetworkReply Выполнение сетевых запросов с помощью Qt может быть утомительным — подход сигнал/слот нарушает поток вашего кода. Цепочка запросов и обработка ошибок быстро превращаются в беспорядок, и ваш код разбивается на множество функций. Но не в QCoro, где вы можете просто co_await завершения QNetworkReply :
QNetworkAccessManager qnam;
QNetworkReply *reply = qnam.get(QStringLiteral("https://github.com/qcoro/qcoro"));const автоматическое содержимое = co_await ответа;
ответ->deleteLater();if (reply->error() != QNetworkReply::NoError) {co_return handleError(reply);
} const auto link = findLinkInReturnedHtmlCode (содержание);
ответ = qnam.get(ссылка);const автоматические данные = co_await ответа;
ответ->deleteLater();if (reply->error() != QNetworkReply::NoError) {co_return handleError(reply);
}
...Полная документация здесь.
QTimer Возможно, вы хотите отложить выполнение своего кода на секунду, возможно, вы хотите выполнять какой-то код через повторяющийся интервал. Это становится супертривиальным с co_await :
Таймер QTimer;
timer.setInterval(1с);
timer.start();for (int i = 1; i <= 100; ++i) {co_await timer;qDebug() << "Ожидание " << i << " секунд...";
}qDebug() << "Готово!";Полная документация здесь.
QIODevice QIODevice — это базовый класс для многих классов Qt, которые позволяют асинхронно записывать и читать данные. Как узнать, что есть данные, готовые к чтению? Вы можете подключиться к QIODevice::readyRead() отдельно или использовать QCoro и co_await объекта:
Socket->write("PING");// Ожидание "понга"const auto data = co_awaitocket;co_return CalcultLatency(data);Полная документация здесь.
Проверьте полную документацию, чтобы узнать больше.
Иногда невозможно использовать co_await для обработки результата сопрограммы — обычно при взаимодействии со сторонним кодом, который не поддерживает сопрограммы. В этих сценариях можно связать обратный вызов продолжения с сопрограммой, который будет вызываться асинхронно после завершения сопрограммы.
void RegularFunction() {someCoroutineReturningInt().then([](int result) {// обработать результат});
} Обратный вызов продолжения также может быть сопрограммой, а результатом всего выражения будет Task, где T — тип возвращаемого значения продолжения. Благодаря этому можно co_await всю цепочку или несколько продолжений .then() .
Полная документация здесь.
Генератор — это сопрограмма, которая лениво создает несколько значений. Хотя в QCoro нет ничего специфичного для Qt, он предоставляет пользователям необходимые инструменты для создания собственных генераторов в своих приложениях Qt.
QCoro предоставляет API как для синхронных генераторов ( QCoro::Generator<T> ), так и для асинхронных генераторов ( QCoro::AsyncGenerator<T> ). Оба генератора предоставляют контейнероподобный API: функции-члены begin() и end() , которые возвращают объекты, подобные итераторам, что является хорошо известным и признанным API и делает генераторы совместимыми с существующими алгоритмами.
QCoro::Generator<int> fibonacci() {
quint64 а = 0, б = 0;
Q_FOREVER {co_yield b; const auto tmp = b;
а = б;
б += ТМП;
}
}void printFib(quint64 max) {for (auto fib: fibonacci()) {if (fib > max) {break;
}
std::cout << fib << std::endl;
}
}Полная документация здесь.
MIT License
Copyright (c) 2022 Daniel Vrátil <[email protected]>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. 
