Arcane  4.2.2.0
User documentation
Loading...
Searching...
No Matches
Arcane::ITask Class Referenceabstract

Interface for a concurrent task. More...

#include <arccore/concurrency/Task.h>

Public Member Functions

virtual void launchAndWait ()=0
 Launches the task and blocks until it finishes.
virtual void launchAndWait (ConstArrayView< ITask * > tasks)=0
 Launches the child tasks tasks and blocks until they finish.
virtual void launch ()=0
 Method allowing to launch the task.
virtual void wait ()=0
 Method allowing to wait the end of the task.

Protected Member Functions

virtual ITask_createChildTask (ITaskFunctor *functor)=0

Friends

class TaskFactory

Detailed Description

Interface for a concurrent task.

Tasks are created via TaskFactory.

Definition at line 193 of file Task.h.

Member Function Documentation

◆ launch()

virtual void Arcane::ITask::launch ( )
pure virtual

Method allowing to launch the task.

\warming You must call wait() to delete this object! No warning will be displayed if you forgot to do so.

Warning
Do not mix launchAndWait() methods and launch() / wait() methods.

Implemented in Arcane::OneTBBTask, and Arcane::SerialTask.

◆ launchAndWait() [1/2]

virtual void Arcane::ITask::launchAndWait ( )
pure virtual

Launches the task and blocks until it finishes.

After calling this function, the task is destroyed and must not be used again.

Warning
Do not mix launchAndWait() methods and launch() / wait() methods.

Implemented in Arcane::OneTBBTask, and Arcane::SerialTask.

◆ launchAndWait() [2/2]

virtual void Arcane::ITask::launchAndWait ( ConstArrayView< ITask * > tasks)
pure virtual

Launches the child tasks tasks and blocks until they finish.

Warning
Do not mix launchAndWait() methods and launch() / wait() methods.

Implemented in Arcane::OneTBBTask, and Arcane::SerialTask.

◆ wait()

virtual void Arcane::ITask::wait ( )
pure virtual

Method allowing to wait the end of the task.

This method must be called after launch() method.

Warning
Do not mix launchAndWait() methods and launch() / wait() methods.

Implemented in Arcane::OneTBBTask, and Arcane::SerialTask.

◆ TaskFactory

friend class TaskFactory
friend

Definition at line 195 of file Task.h.


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