QtTaskTree Namespace

类型文档

[alias] BarrierKickerGetter

接受QStoredBarrier 并返回ExecutableItem 的函数的类型别名，即std::function<ExecutableItem(const QStoredBarrier &)> ，用于在When 构造函数中。

enum class QtTaskTree::CallDoneFlag
flags QtTaskTree::CallDone

此枚举是onGroupDone()元素或自定义任务构造函数的可选参数。它用于指示任务树何时应调用组或任务的完成处理程序。

CallDone 类型是QFlags<CallDoneFlag> 的 typedef。它存储 CallDoneFlag 值的或（OR）组合。

enum class QtTaskTree::DoneResult

该枚举可由组或任务的完成处理函数可选地返回。当完成处理函数未返回任何值时，即其返回类型为void ，其最终返回值将由正在运行的任务树自动推导出来，并上报给其父组。

当完成处理程序返回 `DoneResult` 时，您可以在处理程序内部调整最终返回值。

当组完成处理程序返回 DoneResult 时，将忽略该组的工作流策略。

此枚举在 TaskInterface::done() 信号中也会使用，它指示任务是成功完成还是出现错误。

enum class QtTaskTree::DoneWith

此枚举是组或任务的完成处理程序的可选参数。它指示组或任务是成功完成、出现错误，还是被取消。

它还用作QTaskTree::done()信号中的参数，用于指示QTaskTree 执行的最终结果。

[alias] QtTaskTree::GroupItems

QList<GroupItem> 的类型别名。

[alias] QBarrierTask

QCustomTask<QBarrier> 的类型别名，用于在配方中使用。

[alias] QNetworkReplyWrapperTask

QCustomTask<QNetworkReplyWrapper>的类型别名，用于在配方中使用。

[alias] QProcessTask

为QCustomTask<QProcess> 定义类型别名，使用QProcessTaskDeleter ，供在配方中使用。

[alias] QStoredBarrier

QtTaskTree::Storage<QStartedBarrier> 的类型别名，用于在配方中使用。

[alias] QTaskTreeTask

QCustomTask<QTaskTree> 的类型别名，用于在配方中使用。

[alias] QTcpSocketWrapperTask

QCustomTask<QTcpSocketWrapper> 的类型别名，用于在配方中使用。

[alias] template <typename ResultType> QThreadFunctionTask

QCustomTask<QThreadFunction<ResultType>> 的类型别名，其中ResultType 指定线程函数的返回类型，用于在配方中。

[alias] QTimeoutTask

QCustomTask 的类型别名 <std::chrono::milliseconds> ，用于在配方中使用。std::chrono::milliseconds 用于设置超时时长。默认超时行为为std::chrono::milliseconds::zero() ，即当控制权返回正在运行的事件循环时，QTimeoutTask 立即结束。

使用示例：

using namespace std::chrono;
using namespace std::chrono_literals;

const auto onSetup = [](milliseconds &timeout) { timeout = 1000ms; }
const auto onDone = [] { qDebug() << "Timed out."; }

const Group root {
    QTimeoutTask(onSetup, onDone)
};

另请参阅 timeoutTask()。

enum class QtTaskTree::SetupResult

该枚举可选地由组或任务的初始化处理函数返回。它指示正在运行的任务树在初始化处理函数执行完成后应如何继续。

[alias] QtTaskTree::TreeDoneHandler

std::function<void(constQTaskTree &,QtTaskTree::DoneWith)> 的类型别名。

TreeDoneHandler 是任务树运行器中用于调度任务树执行的函数的可选参数。当任务树运行器的配方执行完毕时，该函数会被调用。通过传入的参数可以访问QTaskTree 以及配方的结果。

任务树运行器还接受以下简写形式的处理程序：std::function<void(const QTaskTree &)> 、std::function<void(QtTaskTree::DoneWith)> 或std::function<void(void)> 。

[alias] QtTaskTree::TreeSetupHandler

std::function<void(QTaskTree &)> 的类型别名。

TreeSetupHandler 是任务树运行器中用于调度任务树执行的函数的可选参数。当任务树运行器即将执行其配方时，会调用该函数。通过传入的参数可访问QTaskTree 。

任务树运行器还接受采用std::function<void(void)> 简写形式的处理程序。

enum class QtTaskTree::WorkflowPolicy

此枚举描述了当任何组中的子任务执行完毕时，“Group”元素可能表现出的行为。当正在运行的“Group”被取消时，也会用到该枚举。

每当子任务的结果导致组停止执行时，即在采用 StopOnError、 StopOnSuccess 或 StopOnSuccessOrError 策略时，该组将取消其他正在运行的子任务（如有——例如在并行模式下），并跳过尚未开始执行的任务（例如在顺序模式下——位于失败任务之后的那部分任务）。 当使用“ParallelLimit ”时，可能会同时发生取消和跳过子任务的情况。

下表总结了各种工作流策略之间的差异：

如果一个组的子组也是一个组，则该子组将根据其自身的流工作政策运行其任务。 当父组因其工作流策略而停止正在运行的子组时，即当父组使用了 StopOnError、StopOnSuccess 或 StopOnSuccessOrError 策略时，子组的结果将根据“结果”列以及上表中子组的工作流策略行进行报告。