QtTaskTree Namespace

类型文档

[alias] BarrierKickerGetter

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

枚举类 QtTaskTree::CallDoneFlag
flags QtTaskTree::CallDone

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

CallDone 类型是QFlags<CallDoneFlag> 的类型定义。它存储 CallDoneFlag 值的 OR 组合。

enum class QtTaskTree::DoneResult

该枚举可选择从组或任务的已完成处理程序函数中返回。当 done 处理程序不返回任何值（即其返回类型为void ）时，其最终返回值将由运行中的任务树自动推导并报告给其父组。

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

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

任务接口::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>> 的类型别名，用于配方内部。

[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

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

只要子任务的结果导致组停止，即在 StopOnError、StopOnSuccess 或 StopOnSuccessOrError 策略的情况下，组就会取消其他正在运行的子任务（如果有的话--例如在并行模式下），并跳过尚未开始执行的任务（例如在顺序模式下--那些放在失败任务之后的任务）。使用ParallelLimit 时，取消和跳过子任务都可能发生。

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

如果组的子组也是组，则子组根据自己的工作流策略运行任务。当父组因为父组的工作流策略而停止正在运行的子组（即父组使用了 StopOnError、StopOnSuccess 或 StopOnSuccessOrError 策略）时，子组的结果将根据结果列和上表中子组的工作流策略行进行报告。