QtTaskTree Namespace

Documentation sur les types

[alias] BarrierKickerGetter

Alias de type pour la fonction prenant un ` QStoredBarrier ` et renvoyant un ` ExecutableItem`, c'est-à-dire ` std::function<ExecutableItem(const QStoredBarrier &)>`, à utiliser dans le constructeur ` When `.

enum class QtTaskTree::CallDoneFlag
flags QtTaskTree::CallDone

Cette énumération est un argument facultatif du constructeur de l'élément onGroupDone() ou d'une tâche personnalisée. Elle indique à l'arborescence des tâches à quel moment le gestionnaire « done » du groupe ou de la tâche doit être appelé.

Le type `CallDone` est un `typedef` de ` QFlags<CallDoneFlag>`. Il stocke une combinaison « ou » (OR) de valeurs `CallDoneFlag`.

enum class QtTaskTree::DoneResult

Cette énumération est renvoyée de manière facultative par la fonction de gestionnaire « done » du groupe ou de la tâche. Lorsque le gestionnaire « done » ne renvoie aucune valeur, c'est-à-dire que son type de retour est ` void`, sa valeur de retour finale est automatiquement déduite par l'arborescence des tâches en cours d'exécution et signalée à son groupe parent.

Lorsque la fonction de gestion « done » renvoie un `DoneResult`, vous pouvez modifier la valeur de retour finale au sein de cette fonction.

Lorsque `DoneResult` est renvoyé par la fonction de gestion « done » du groupe, la politique de workflow du groupe est ignorée.

Cette énumération est également utilisée dans le signal `TaskInterface::done()` et indique si la tâche s’est terminée avec succès ou a généré une erreur.

enum class QtTaskTree::DoneWith

Cette énumération est un argument facultatif pour le gestionnaire de fin d'exécution du groupe ou de la tâche. Elle indique si le groupe ou la tâche s'est terminée avec succès, a généré une erreur ou a été annulée.

Elle est également utilisée comme argument dans le signal ` QTaskTree::done()`, indiquant le résultat final de l'exécution de la ` QTaskTree `.

[alias] QtTaskTree::GroupItems

Alias de type pour QList<GroupItem>.

[alias] QBarrierTask

Alias de type pour l'QCustomTask<QBarrier>, à utiliser dans les recettes.

[alias] QNetworkReplyWrapperTask

Alias de type pour l'QCustomTask<QNetworkReplyWrapper>, à utiliser dans les recettes.

[alias] QProcessTask

Alias de type pour l'QCustomTask<QProcess>, utilisant QProcessTaskDeleter, à utiliser dans les recettes.

[alias] QStoredBarrier

Alias de type pour l'QtTaskTree::Storage<QStartedBarrier>, à utiliser dans les recettes.

[alias] QTaskTreeTask

Alias de type pour l'QCustomTask<QTaskTree>, à utiliser dans les recettes.

[alias] QTcpSocketWrapperTask

Alias de type pour l'QCustomTask<QTcpSocketWrapper>, à utiliser dans les recettes.

[alias] template <typename ResultType> QThreadFunctionTask

Alias de type pour QCustomTask<QThreadFunction<ResultType>>, où ResultType spécifie le type de retour de la fonction de thread, à utiliser dans les recettes.

[alias] QTimeoutTask

Alias de type pour l’ QCustomTask<std::chrono::milliseconds>, à utiliser dans les recettes. L’ std::chrono::milliseconds permet de définir la durée du délai d’expiration. Le délai d’expiration par défaut est std::chrono::milliseconds::zero(), c’est-à-dire que la QTimeoutTask se termine dès que le contrôle revient à la boucle d’événements en cours d’exécution.

Exemple d'utilisation :

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)
};

Voir également timeoutTask().

enum class QtTaskTree::SetupResult

Cette énumération est renvoyée de manière facultative par la fonction de gestion de la configuration du groupe ou de la tâche. Elle indique à l'arborescence des tâches en cours d'exécution comment procéder une fois l'exécution de la fonction de gestion de la configuration terminée.

[alias] QtTaskTree::TreeDoneHandler

Alias de type pour std::function<void(const QTaskTree &, QtTaskTree::DoneWith)>.

TreeDoneHandler est un argument facultatif des fonctions des exécuteurs d’arbres de tâches chargées de planifier l’exécution de l’arbre de tâches. La fonction est appelée lorsque la recette de l’exécuteur d’arbres de tâches a terminé son exécution. L’accès à QTaskTree et au résultat de la recette s’effectue via les arguments passés.

Les exécuteurs d’arbres de tâches acceptent également des gestionnaires sous une forme abrégée : std::function<void(const QTaskTree &)>, std::function<void(QtTaskTree::DoneWith)> ou std::function<void(void)>.

[alias] QtTaskTree::TreeSetupHandler

Alias de type pour std::function<void(QTaskTree &)>.

TreeSetupHandler est un argument facultatif des fonctions des exécuteurs d’arbres de tâches chargées de planifier l’exécution de l’arbre de tâches. La fonction est appelée lorsque l’exécuteur d’arbres de tâches s’apprête à exécuter sa recette. L’accès à QTaskTree se fait via l’argument passé.

Les exécuteurs d'arbres de tâches acceptent également des gestionnaires sous une forme abrégée de ` std::function<void(void)>`.

enum class QtTaskTree::WorkflowPolicy

Cette énumération décrit les comportements possibles de l'élément « Group » lorsqu'une tâche enfant d'un groupe quelconque termine son exécution. Elle est également utilisée lorsque le « Group » en cours d'exécution est annulé.

Dès que le résultat d’une tâche enfant provoque l’arrêt du groupe, c’est-à-dire dans le cas des politiques « StopOnError », StopOnSuccess ou StopOnSuccessOrError, le groupe annule les autres tâches enfants en cours d’exécution (le cas échéant, par exemple en mode parallèle) et ignore l’exécution des tâches qu’il n’a pas encore lancées (par exemple, en mode séquentiel, celles qui sont placées après la tâche ayant échoué). L’annulation et le saut des tâches filles peuvent tous deux se produire lorsque l’on utilise « ParallelLimit ».

Le tableau ci-dessous résume les différences entre les différentes politiques de workflow :

Si un enfant d’un groupe est lui-même un groupe, ce groupe enfant exécute ses tâches conformément à sa propre stratégie de workflow. Lorsqu’un groupe parent arrête le groupe enfant en cours d’exécution en raison de sa propre politique de workflow, c’est-à-dire lorsque la politique StopOnError, StopOnSuccess ou StopOnSuccessOrError a été appliquée au groupe parent, le résultat du groupe enfant est indiqué conformément à la colonne Résultat et à la ligne correspondant à la politique de workflow du groupe enfant dans le tableau ci-dessus.