LowLevelTasks::FTask Class Reference

#include <Task.h>

Inheritance diagram for LowLevelTasks::FTask:

Classes
struct	FInitData

Public Member Functions
bool	IsCompleted (std::memory_order MemoryOrder=std::memory_order_seq_cst) const
bool	WasCanceled () const
bool	WasExpedited () const
bool	IsReady () const
bool	TryCancel (ECancellationFlags CancellationFlags=ECancellationFlags::DefaultFlags)
bool	TryRevive ()
bool	TryExpedite ()
bool	TryExpedite (FTask *&Continuation)
bool	TryExecute ()
bool	TryExecute (FTask *&Continuation)
template<typename TRunnable >
void	Init (const TCHAR *InDebugName, ETaskPriority InPriority, TRunnable &&InRunnable, ETaskFlags Flags=ETaskFlags::DefaultFlags)
template<typename TRunnable >
void	Init (const TCHAR *InDebugName, TRunnable &&InRunnable, ETaskFlags Flags=ETaskFlags::DefaultFlags)
const TCHAR *	GetDebugName () const
ETaskPriority	GetPriority () const
bool	IsBackgroundTask () const
bool	AllowBusyWaiting () const
bool	AllowCancellation () const
FInitData	GetInitData () const
void *	GetUserData () const
void	SetUserData (void *NewUserData) const
	FTask ()=default
	~FTask ()

Static Public Member Functions
static CORE_API const FTask *	GetActiveTask ()

Friends
class	FScheduler

Constructor & Destructor Documentation

FTask()

LowLevelTasks::FTask::FTask ( )

default

~FTask()

LowLevelTasks::FTask::~FTask ( )

inline

Member Function Documentation

AllowBusyWaiting()

bool LowLevelTasks::FTask::AllowBusyWaiting ( ) const

inline

AllowCancellation()

bool LowLevelTasks::FTask::AllowCancellation ( ) const

inline

GetActiveTask()

const FTask * LowLevelTasks::FTask::GetActiveTask ( )

static

GetDebugName()

const TCHAR * LowLevelTasks::FTask::GetDebugName ( ) const

inline

GetInitData()

FTask::FInitData LowLevelTasks::FTask::GetInitData ( ) const

inline

GetPriority()

ETaskPriority LowLevelTasks::FTask::GetPriority ( ) const

inline

GetUserData()

void * LowLevelTasks::FTask::GetUserData ( ) const

inline

Init() [1/2]

template<typename TRunnable >

void LowLevelTasks::FTask::Init ( const TCHAR *  InDebugName, ETaskPriority  InPriority, TRunnable &&  InRunnable, ETaskFlags  Flags = ETaskFlags::DefaultFlags  )

inline

Init() [2/2]

template<typename TRunnable >

void LowLevelTasks::FTask::Init ( const TCHAR *  InDebugName, TRunnable &&  InRunnable, ETaskFlags  Flags = ETaskFlags::DefaultFlags  )

inline

IsBackgroundTask()

bool LowLevelTasks::FTask::IsBackgroundTask ( ) const

inline

IsCompleted()

bool LowLevelTasks::FTask::IsCompleted ( std::memory_order  MemoryOrder = std::memory_order_seq_cst ) const

inline

IsReady()

bool LowLevelTasks::FTask::IsReady ( ) const

inline

SetUserData()

void LowLevelTasks::FTask::SetUserData ( void *  NewUserData ) const

inline

TryCancel()

bool LowLevelTasks::FTask::TryCancel ( ECancellationFlags  CancellationFlags = ECancellationFlags::DefaultFlags )

inline

TryExecute() [1/2]

bool LowLevelTasks::FTask::TryExecute ( )

inline

TryExecute() [2/2]

bool LowLevelTasks::FTask::TryExecute ( FTask *&  Continuation )

inline

TryExpedite() [1/2]

bool LowLevelTasks::FTask::TryExpedite ( )

inline

TryExpedite() [2/2]

bool LowLevelTasks::FTask::TryExpedite ( FTask *&  Continuation )

inline

TryRevive()

bool LowLevelTasks::FTask::TryRevive ( )

inline

WasCanceled()

bool LowLevelTasks::FTask::WasCanceled ( ) const

inline

WasExpedited()

bool LowLevelTasks::FTask::WasExpedited ( ) const

inline

Friends And Related Symbol Documentation

FScheduler

friend class FScheduler

friend

---

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

• Engine/Source/Runtime/Core/Public/Async/Fundamental/Task.h
• Engine/Source/Runtime/Core/Private/Async/Fundamental/Scheduler.cpp