1. Epic GamesDeveloper
  3. FTask

FTask

Minimal low level task interface

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Async > API/Runtime/Core/Async/Fundamental

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Async/Fundamental/Task.h
Include #include "Async/Fundamental/Task.h"

Syntax

class FTask : private LowLevelTasks::Tasks_Impl::FTaskBase

Remarks

Minimal low level task interface

Constructors

  Type Name Description
Public function  

FTask ()

  

Destructors

  Type Name Description
Public function  

~FTask ()

  

Functions

  Type Name Description
Public function Const bool  
Public function Const bool  
Public function Static const FTask * Get the currently active task if any
Public function Const const TCHAR *  
Public function Const FInitData  
Public function Const ETaskPriority  
Public function Const void *  
Public function void

Init ( const TCHAR* InDebugName,
ETaskPriority InPriority,
TRunnable&& InRunnable,
ETaskFlags Flags
)

  
Public function void

Init ( const TCHAR* InDebugName,
TRunnable&& InRunnable,
ETaskFlags Flags
)

  
Public function Const bool  
Public function Const bool

IsCompleted ( std::memory_order MemoryOrder
)

 Means the task is completed and this taskhandle can be recycled
Public function Const bool

IsReady ()

 Means the task is ready to be launched but might already been canceled
Public function Const void

SetUserData ( void* NewUserData
)

  
Public function bool

TryCancel ( ECancellationFlags CancellationFlags
)

 Try to cancel the task if it has not been launched yet.
Public function bool Try to execute the task if it has not been launched yet the task will execute immediately.
Public function bool

TryExecute ( FTask*& Continuation
)

 Try to execute the task if it has not been launched yet the task will execute immediately.
Public function bool Try to expedite the task if succeded it will run immediately but it will not set the completed state until the scheduler has executed it, because the scheduler still holds a reference.
Public function bool

TryExpedite ( FTask*& Continuation
)

 Try to expedite the task if succeded it will run immediately but it will not set the completed state until the scheduler has executed it, because the scheduler still holds a reference.
Public function bool Try to revive a canceled task (as in reverting the cancellation as if it never happened).
Public function Const bool Means the task was canceled but might still need to be launched
Public function Const bool Means the task was expedited or that it already completed

Classes

  Type Name Description
Public struct FInitData    

Constants

Name Description
ActiveTask  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page