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

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

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

グループの done ハンドラによって 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 ポリシーが使用された場合）に基づいて実行中の子グループを停止した場合、子グループの結果は、上記の表の [Result] 列および子グループのワークフロー ポリシーの行に従って報告されます。