\inheaderfile solutions/tasking/tasktree.h \inmodule TaskingSolution More...

#include <tasktree.h>

Inheritance diagram for Tasking::GroupItem:

Collaboration diagram for Tasking::GroupItem:

Classes
struct	GroupData

struct	GroupHandler

struct	TaskHandler

Public Types
using	GroupSetupHandler = std::function<SetupResult()>

using	GroupDoneHandler = std::function<DoneResult(DoneWith)>

Public Member Functions
template<typename StorageStruct >
	GroupItem (const Storage< StorageStruct > &storage)
	Constructs a `GroupItem` element holding the storage object.

	GroupItem (const Loop &loop)

	GroupItem (const QList< GroupItem > &children)
	Constructs a `GroupItem` element with a given list of items.

	GroupItem (std::initializer_list< GroupItem > children)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Protected Types
enum class	Type { List , Group , GroupData , Storage , TaskHandler }

using	InterfaceCreateHandler = std::function<TaskInterface *(void)>

using	InterfaceSetupHandler = std::function<SetupResult(TaskInterface &)>

using	InterfaceDoneHandler = std::function<DoneResult(const TaskInterface &, DoneWith)>

Protected Member Functions
	GroupItem ()=default

	GroupItem (Type type)

	GroupItem (const GroupData &data)

	GroupItem (const TaskHandler &handler)

void	addChildren (const QList< GroupItem > &children)

Static Protected Member Functions
static GroupItem	groupHandler (const GroupHandler &handler)

static GroupItem	parallelLimit (int limit)

static GroupItem	workflowPolicy (WorkflowPolicy policy)

template<typename Result , typename Function , typename ... Args, typename DecayedFunction = std::decay_t<Function>>
static constexpr bool	isInvocable ()

Friends
class	ContainerNode

class	TaskNode

class	TaskTreePrivate

Detailed Description

\inheaderfile solutions/tasking/tasktree.h \inmodule TaskingSolution

GroupItem represents the basic element that may be a part of any Group. \reentrant

GroupItem is a basic element that may be a part of any \l {Tasking::Group} {Group}. It encapsulates the functionality provided by any GroupItem's subclass. It is a value type and it is safe to copy the GroupItem instance, even when it is originally created via the subclass' constructor.

There are four main kinds of GroupItem: \table \header

GroupItem Kind
Brief Description \row
\l CustomTask
Defines asynchronous task type and task's start, done, and error handlers. Aliased with a unique task name, such as, ConcurrentCallTask<ResultType> or NetworkQueryTask. Asynchronous tasks are the main reason for using a task tree. \row
\l {Tasking::Group} {Group}
A container for other group items. Since the group is of the GroupItem type, it's possible to nest it inside another group. The group is seen by its parent as a single asynchronous task. \row
GroupItem containing \l {Tasking::Storage} {Storage}
Enables the child tasks of a group to exchange data. When GroupItem containing \l {Tasking::Storage} {Storage} is placed inside a group, the task tree instantiates the storage's data object just before the group is entered, and destroys it just after the group is left. \row
Other group control items
The items returned by \l {Tasking::parallelLimit()} {parallelLimit()} or \l {Tasking::workflowPolicy()} {workflowPolicy()} influence the group's behavior. The items returned by \l {Tasking::onGroupSetup()} {onGroupSetup()} or \l {Tasking::onGroupDone()} {onGroupDone()} define custom handlers called when the group starts or ends execution. \endtable

Definition at line 208 of file tasktree.h.

Member Typedef Documentation

◆ GroupDoneHandler

using Tasking::GroupItem::GroupDoneHandler = std::function<DoneResult(DoneWith)>

Definition at line 214 of file tasktree.h.

◆ GroupSetupHandler

using Tasking::GroupItem::GroupSetupHandler = std::function<SetupResult()>

Definition at line 212 of file tasktree.h.

◆ InterfaceCreateHandler

using Tasking::GroupItem::InterfaceCreateHandler = std::function<TaskInterface *(void)>

protected

Definition at line 229 of file tasktree.h.

◆ InterfaceDoneHandler

using Tasking::GroupItem::InterfaceDoneHandler = std::function<DoneResult(const TaskInterface &, DoneWith)>

protected

Definition at line 233 of file tasktree.h.

◆ InterfaceSetupHandler

using Tasking::GroupItem::InterfaceSetupHandler = std::function<SetupResult(TaskInterface &)>

protected

Definition at line 231 of file tasktree.h.

Member Enumeration Documentation

◆ Type

enum class Tasking::GroupItem::Type

strongprotected

Enumerator
List
Group
GroupData
Storage
TaskHandler

Definition at line 255 of file tasktree.h.

Constructor & Destructor Documentation

◆ GroupItem() [1/8]

template<typename StorageStruct >

template< typename StorageStruct > Tasking::GroupItem::GroupItem ( const Storage< StorageStruct > & storage )

inline

Constructs a GroupItem element holding the storage object.

When the \l {Tasking::Group} {Group} element containing this GroupItem is entered by the running task tree, an instance of the StorageStruct is created dynamically.

When that group is about to be left after its execution, the previously instantiated StorageStruct is deleted.

The dynamically created instance of StorageStruct is accessible from inside any handler body of the parent \l {Tasking::Group} {Group} element, including nested groups and its tasks, via the \l {Tasking::Storage::operator->()} {Storage::operator->()}, \l {Tasking::Storage::operator*()} {Storage::operator*()}, or Storage::activeStorage() method.

See also: {Tasking::Storage} {Storage}

Definition at line 217 of file tasktree.h.

◆ GroupItem() [2/8]

Tasking::GroupItem::GroupItem ( const Loop & loop )

inline

Definition at line 221 of file tasktree.h.

◆ GroupItem() [3/8]

Tasking::GroupItem::GroupItem ( const QList< GroupItem > & items )

inline

Constructs a GroupItem element with a given list of items.

When this GroupItem element is parsed by the TaskTree, it is simply replaced with its items.

This constructor is useful when constructing a \l {Tasking::Group} {Group} element with lists of GroupItem elements:

static QList<GroupItems> getItems();
 
...
 
const Group root {
    parallel,
    finishAllAndSuccess,
    getItems(), // OK, getItems() list is wrapped into a single GroupItem element
    onGroupSetup(...),
    onGroupDone(...)
};

If you want to create a subtree, use \l {Tasking::Group} {Group} instead.

Note: Don't confuse this GroupItem with the \l {Tasking::Group} {Group} element, as \l {Tasking::Group} {Group} keeps its children nested after being parsed by the task tree, while this GroupItem does not.

See also: {Tasking::Group} {Group}

Definition at line 224 of file tasktree.h.

◆ GroupItem() [4/8]

Tasking::GroupItem::GroupItem ( std::initializer_list< GroupItem > items )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

See also: GroupItem(const QList<Tasking::GroupItem> &items)

Definition at line 225 of file tasktree.h.

◆ GroupItem() [5/8]

Tasking::GroupItem::GroupItem ( )

protecteddefault

◆ GroupItem() [6/8]

Tasking::GroupItem::GroupItem ( Type type )

inlineprotected

Definition at line 264 of file tasktree.h.

◆ GroupItem() [7/8]

Tasking::GroupItem::GroupItem ( const GroupData & data )

inlineprotected

Definition at line 265 of file tasktree.h.

◆ GroupItem() [8/8]

Tasking::GroupItem::GroupItem ( const TaskHandler & handler )

inlineprotected

Definition at line 268 of file tasktree.h.

Member Function Documentation

◆ addChildren()

void Tasking::GroupItem::addChildren ( const QList< GroupItem > & children )

protected

Definition at line 1355 of file tasktree.cpp.

References addChildren(), child, Tasking::GroupItem::GroupHandler::m_callDoneIf, Tasking::GroupItem::GroupHandler::m_doneHandler, Tasking::GroupItem::GroupData::m_groupHandler, Tasking::GroupItem::GroupData::m_loop, Tasking::GroupItem::GroupData::m_parallelLimit, Tasking::GroupItem::GroupHandler::m_setupHandler, Tasking::GroupItem::GroupData::m_workflowPolicy, QT_ASSERT, qWarning, and storage.

Referenced by addChildren().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ groupHandler()

static GroupItem Tasking::GroupItem::groupHandler ( const GroupHandler & handler )

inlinestaticprotected

Definition at line 273 of file tasktree.h.

◆ isInvocable()

template<typename Result , typename Function , typename ... Args, typename DecayedFunction = std::decay_t<Function>>

static constexpr bool Tasking::GroupItem::isInvocable ( )

inlinestaticconstexprprotected

Definition at line 280 of file tasktree.h.

◆ parallelLimit()

static GroupItem Tasking::GroupItem::parallelLimit ( int limit )

inlinestaticprotected

Definition at line 274 of file tasktree.h.

◆ workflowPolicy()

static GroupItem Tasking::GroupItem::workflowPolicy ( WorkflowPolicy policy )

inlinestaticprotected

Definition at line 275 of file tasktree.h.

References policy.

Friends And Related Symbol Documentation

◆ ContainerNode

friend class ContainerNode

friend

Definition at line 289 of file tasktree.h.

◆ TaskNode

friend class TaskNode

friend

Definition at line 290 of file tasktree.h.

◆ TaskTreePrivate

friend class TaskTreePrivate

friend

Definition at line 291 of file tasktree.h.

The documentation for this class was generated from the following files:

qtbase/src/assets/downloader/tasking/tasktree.h (78de81e286d89a5396b08b67ca98ccedda8a836f)
qtbase/src/assets/downloader/tasking/tasktree.cpp (7c3db02ad3753a4dc6bb691588cf1e0b4a89514f)

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ GroupDoneHandler

◆ GroupSetupHandler

◆ InterfaceCreateHandler

◆ InterfaceDoneHandler

◆ InterfaceSetupHandler

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ GroupItem() [1/8]

◆ GroupItem() [2/8]

◆ GroupItem() [3/8]

◆ GroupItem() [4/8]

◆ GroupItem() [5/8]

◆ GroupItem() [6/8]

◆ GroupItem() [7/8]

◆ GroupItem() [8/8]

Member Function Documentation

◆ addChildren()

◆ groupHandler()

◆ isInvocable()

◆ parallelLimit()

◆ workflowPolicy()

Friends And Related Symbol Documentation

◆ ContainerNode

◆ TaskNode

◆ TaskTreePrivate