QtTaskTree Namespace

Documentation des types

[alias] BarrierKickerGetter

Type alias pour la fonction prenant QStoredBarrier et retournant 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 pour l'élément onGroupDone() ou le constructeur d'une tâche personnalisée. Elle indique à l'arbre des tâches quand le gestionnaire de tâches du groupe ou de la tâche doit être invoqué.

Le type CallDone est un typedef pour QFlags<CallDoneFlag>. Il stocke une combinaison OU de valeurs CallDoneFlag.

enum class QtTaskTree::DoneResult

Cette énumération est optionnellement renvoyée par la fonction done handler 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'arbre des tâches en cours d'exécution et communiquée à son groupe parent.

Lorsque le gestionnaire done renvoie le DoneResult, vous pouvez modifier la valeur de retour finale à l'intérieur du gestionnaire.

Lorsque le DoneResult est renvoyé par le gestionnaire done du groupe, la politique de flux de travail 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 avec une erreur.

enum class QtTaskTree::DoneWith

Cette énumération est un argument facultatif pour le gestionnaire d'achèvement du groupe ou de la tâche. Elle indique si le groupe ou la tâche s'est terminé par un succès ou une erreur, ou s'il a été annulé.

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

[alias] QtTaskTree::GroupItems

Type d'alias pour QList<GroupItem>.

[alias] QBarrierTask

Type d'alias pour le QCustomTask<QBarrier>, à utiliser dans les recettes.

[alias] QNetworkReplyWrapperTask

Type d'alias pour le QCustomTask<QNetworkReplyWrapper>, à utiliser dans les recettes.

[alias] QProcessTask

Type d'alias pour le QCustomTask<QProcess>, utilisant QProcessTaskDeleter, à utiliser dans les recettes.

[alias] QStoredBarrier

Type d'alias pour le QtTaskTree::Storage<QStartedBarrier>, à utiliser dans les recettes.

[alias] QTaskTreeTask

Type d'alias pour le QCustomTask<QTaskTree>, à utiliser dans les recettes.

[alias] QTcpSocketWrapperTask

Type d'alias pour le QCustomTask<QTcpSocketWrapper>, à utiliser dans les recettes.

[alias] template <typename ResultType> QThreadFunctionTask

Type alias pour le QCustomTask<QThreadFunction<ResultType>>, à utiliser dans les recettes.

[alias] QTimeoutTask

Type d'alias pour le QCustomTask<std::chrono::milliseconds>, à utiliser dans les recettes. std::chrono::milliseconds est utilisé pour définir la durée du délai d'attente. La durée par défaut est std::chrono::milliseconds::zero(), c'est-à-dire que la QTimeoutTask se termine dès que le contrôle revient dans la boucle d'événements en cours.

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 optionnellement renvoyée par la fonction de gestion de l'installation du groupe ou de la tâche. Elle indique à l'arbre des tâches en cours d'exécution comment procéder après la fin de l'exécution du gestionnaire de configuration.

[alias] QtTaskTree::TreeDoneHandler

Type alias de std::function<void(const QTaskTree &, QtTaskTree::DoneWith)>.

Le TreeDoneHandler est un argument facultatif des fonctions des exécutants de l'arbre des tâches qui planifient l'exécution de l'arbre des tâches. La fonction est appelée lorsque la recette de l'exécutant de l'arbre des tâches a terminé l'exécution. L'accès à QTaskTree et au résultat de la recette se fait via les arguments passés.

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

[alias] QtTaskTree::TreeSetupHandler

Type alias pour std::function<void(QTaskTree &)>.

L'adresse TreeSetupHandler est un argument facultatif des fonctions des exécutants de l'arbre des tâches qui planifient l'exécution de l'arbre des tâches. La fonction est appelée lorsque l'exécutant de l'arbre des tâches est sur le point d'exécuter sa recette. L'accès à QTaskTree se fait via l'argument passé.

Les exécutants d'arborescence des tâches acceptent également des gestionnaires sous la forme abrégée de std::function<void(void)>.

enum class QtTaskTree::WorkflowPolicy

Cette énumération décrit le comportement possible de l'élément Group lorsque la tâche enfant d'un groupe termine son exécution. Elle est également utilisée lorsque le groupe en cours d'exécution est annulé.

Lorsque le résultat d'une tâche enfant entraîne 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 (s'il y en a - par exemple en mode parallèle) et saute les 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 qui a échoué). L'annulation et le saut de tâches enfantines peuvent se produire lorsque ParallelLimit est utilisé.

Le tableau ci-dessous résume les différences entre les diverses politiques de flux de travail :

Si un enfant d'un groupe est également un groupe, le groupe enfant exécute ses tâches conformément à sa propre politique de flux de travail. Lorsqu'un groupe parent arrête le groupe enfant en cours d'exécution en raison de la politique de flux de travail du groupe parent, c'est-à-dire lorsque la politique StopOnError, StopOnSuccess ou StopOnSuccessOrError a été utilisée pour le parent, le résultat du groupe enfant est indiqué dans la colonne Result et sur la ligne Politique de flux de travail du groupe enfant dans le tableau ci-dessus.