QtTaskTree Namespace

型のドキュメント

[alias] BarrierKickerGetter

QStoredBarrier を受け取り、ExecutableItem を返す関数、すなわちstd::function<ExecutableItem(const QStoredBarrier &)> の型エイリアス。When コンストラクタ内部で使用します。

enum class QtTaskTree::CallDoneFlag
flags QtTaskTree::CallDone

この enum は、onGroupDone() 要素またはカスタムタスクのコンストラクタのオプション引数です。これは、グループまたはタスクの done ハンドラがいつ呼び出されるべきかをタスクツリーに指示します。

CallDone 型はQFlags<CallDoneFlag> の typedef です。CallDoneFlag 値の OR の組み合わせを格納します。

enum class QtTaskTree::DoneResult

この列挙型は、グループまたはタスクの done ハンドラ関数からオプションで返される。done ハンドラーが値を返さない場合、つまり戻り値の型がvoid の場合、その最終的な戻り値は実行中のタスクツリーによって自動的に推測され、親グループに報告されます。

done ハンドラーが DoneResult を返す場合、ハンドラー内部で最終的な戻り値を微調整することができます。

グループの done ハンドラから DoneResult が返された場合、グループのワークフローポリシーは無視される。

この列挙型は、TaskInterface::done() シグナル内部でも使用され、タスクが成功で終了したかエラーで終了したかを示します。

enum class QtTaskTree::DoneWith

この列挙型はグループまたはタスクの done ハンドラのオプション引数である。グループやタスクが成功で終了したのか、エラーで終了したのか、キャンセルされたのかを示します。

また、QTaskTree の実行の最終結果を示すQTaskTree::done() シグナル内の引数としても使用されます。

[alias] QtTaskTree::GroupItems

QList<GroupItem>のエイリアスを入力する。

[alias] QBarrierTask

レシピの中で使われる、QCustomTask<QBarrier> のエイリアスをタイプする。

[alias] QNetworkReplyWrapperTask

レシピの中で使われる、QCustomTask<QNetworkReplyWrapper> のエイリアスをタイプする。

[alias] QProcessTask

QProcessTaskDeleter を使って、QCustomTask<QProcess> のエイリアスを作り、レシピの中で使う。

[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

この列挙型は、グループの子タスクが実行を終了したときのGroup要素の動作を記述します。また、実行中の Group がキャンセルされた場合にも使用されます。

子タスクの結果によってグループが停止する場合（StopOnError、StopOnSuccess、StopOnSuccessOrError ポリシーの場合）、グループは実行中の他の子タスクをキャンセルし（並列モードの場合など）、まだ開始していないタスクの実行をスキップします（逐次モードの場合など、失敗したタスクの後にあるタスク）。子タスクのキャンセルとスキップは、ParallelLimit 。

以下の表は、様々なワークフロー ポリシーの違いをまとめたものです：

グループの子もグループである場合、子グループは自身のワークフローポリシーに 従ってタスクを実行する。親グループのワークフロー ポリシーにより、親グループが実行中の子グループを停止した場合、つまり、StopOnError、StopOnSuccess、または StopOnSuccessOrError ポリシーが親に使用された場合、子グループの結果は、上の表のResult列と子グループのワークフロー ポリシー行に従って報告されます。