1. Epic GamesDeveloper
  3. Tasks

Tasks

API > API/Runtime > API/Runtime/Core

Classes

  Type Name Description
Public class FCancellationToken Support for canceling tasks mid-execution usage: FCancellationToken Token; Launch(UE_SOURCE_LOCATION, [&Token] { ... if (Token.IsCanceled()) return; ... }); Token.Cancel();  
Public class FConcurrencySlots A queue of free slots in range [0 .. max_concurrency). Initially contains all slots in the range.  
Public class FPimpl An implementation details of FTaskConcurrenctyLimiter  
Public class FPipe A chain of tasks that are executed one after another.  
Public class FTaskBase An abstract base class for task implementation.  
Public class FTaskConcurrencyLimiter A lightweight construct that limits the concurrency of tasks pushed into it.  
Public class FTaskEvent A synchronisation primitive, a recommended substitution of `FEvent_ for signalling between tasks.  
Public class FTaskEventBase A special kind of task that is used for signalling or dependency management.  
Public class FTaskHandle A common part of the generic [TTask](API\Runtime\Core\Tasks\TTask)<ResultType>_ and its TTask_ specialisation  
Public class FTaskPriorityCVar Console variable for configuring task priorities Example: FTaskPriorityCVar CVar{ TEXT("CVarName"), TEXT("CVarHelp"), ETaskPriority::Normal, EExtendedTaskPriority::None }; Launch(UE_SOURCE_LOCATION, [] {}, CVar.GetTaskPriority(), CVar.GetExtendedTaskPriority()).Wait();  
Public class TExecutableTask A separate derived class to add "small task" allocation optimization to both base class specializations  
Public class TExecutableTaskBase Task implementation that can be executed, as it stores task body.  
Public class TTask A movable/copyable handle of `Private::TTaskWithResult*_ with the API adopted for public usage.  
Public class TTaskWithResult An extension of FTaskBase for tasks that return a result.  

Typedefs

Name Description
FExecutableTaskAllocator  
FTask  
FTaskEventBaseAllocator  

Enums

  Type Name Description
Public enum UE::Tasks::EExtendedTaskPriority Special task priorities for tasks that are never sent to the scheduler  
Public enum UE::Tasks::ETaskFlags    

Functions

  Type Name Description
Public function void

UE::Tasks::AddNested ( const TaskType& Nested
)

 Adds the nested task to the task that is being currently executed by the current thread.
Public function FTask

UE::Tasks::Any ( const TaskCollectionType& Tasks
)

 Returns a task that gets completed as soon as any of the given tasks gets completed.
Public function bool

UE::Tasks::BusyWait ( const TaskCollectionType& Tasks,
FTimespan InTimeout
)

 Wait for multiple tasks while executing other tasks
Public function TTask< TInvokeResult_T< TaskBodyType > >

UE::Tasks::Launch ( const TCHAR* DebugName,
TaskBodyType&& TaskBody,
ETaskPriority Priority,
EExtendedTaskPriority ExtendedPriority,
ETaskFlags Flags
)

 Launches a task for asynchronous execution
Public function TTask< TInvokeResult_T< TaskBodyType > >

UE::Tasks::Launch ( const TCHAR* DebugName,
TaskBodyType&& TaskBody,
PrerequisitesCollectionType&& Prerequisites,
ETaskPriority Priority,
EExtendedTaskPriority ExtendedPriority,
ETaskFlags Flags
)

 Launches a task for asynchronous execution, with prerequisites that must be completed before the task is scheduled
Public function TTask< ResultType >

UE::Tasks::MakeCompletedTask ( ArgTypes&&... Args
)

 Creates and returns an already completed task holding a result value constructed from given args
Public function TStaticArray< Private::FTaskBase *, sizeof...(TaskTypes)>

UE::Tasks::Prerequisites ( TaskTypes&... Tasks
)

  
Public function const TaskCollectionType &

UE::Tasks::Prerequisites ( const TaskCollectionType& Tasks
)

  
Public function TArray< TaskTrace::FId >

UE::Tasks::Private::GetTraceIds ( const TaskCollectionType& Tasks
)

  
Public function bool

UE::Tasks::Private::IsCompleted ( const HigherLevelTaskType& Prerequisite
)

  
Public function void

UE::Tasks::Private::PrerequisitesUnpacker ( ArrayType& Array,
TaskType& Task
)

  
Public function void

UE::Tasks::Private::PrerequisitesUnpacker ( ArrayType& Array,
FirstTaskType& FirstTask,
OtherTasksTypes&... OtherTasks
)

  
Public function bool

UE::Tasks::Private::TryRetractAndExecute ( const TaskCollectionType& Tasks,
FTimeout Timeout
)

 Task retraction of multiple tasks, with timeout.
Public function void  
Public function bool

UE::Tasks::Wait ( const TaskCollectionType& Tasks,
FTimespan InTimeout
)

 Wait for multiple tasks, with timeout
Public function int32

UE::Tasks::WaitAny ( const TaskCollectionType& Tasks,
FTimespan Timeout
)

 "any task" support.

Variables

  Type Name Description
Public variable int32 LargeTaskAlignment  
Public variable int32 SmallTaskSize  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page