UE::Tasks::Private::FTaskHandle Class Reference

#include <Task.h>

Inheritance diagram for UE::Tasks::Private::FTaskHandle:

Public Types
using	FTaskHandleId = void

Public Member Functions
	FTaskHandle ()=default
bool	IsValid () const
bool	IsCompleted () const
bool	Wait (FTimespan Timeout) const
bool	Wait () const
bool	TryRetractAndExecute ()
template<typename TaskBodyType >
void	Launch (const TCHAR *DebugName, TaskBodyType &&TaskBody, ETaskPriority Priority=ETaskPriority::Normal, EExtendedTaskPriority ExtendedPriority=EExtendedTaskPriority::None, ETaskFlags Flags=ETaskFlags::None)
template<typename TaskBodyType , typename PrerequisitesCollectionType >
void	Launch (const TCHAR *DebugName, TaskBodyType &&TaskBody, PrerequisitesCollectionType &&Prerequisites, ETaskPriority Priority=ETaskPriority::Normal, EExtendedTaskPriority ExtendedPriority=EExtendedTaskPriority::None, ETaskFlags Flags=ETaskFlags::None)
bool	IsAwaitable () const
bool	operator== (const FTaskHandle &Other) const
bool	operator!= (const FTaskHandle &Other) const
ETaskPriority	GetPriority () const
EExtendedTaskPriority	GetExtendedPriority () const

Protected Member Functions
	FTaskHandle (FTaskBase *Other)

Protected Attributes
TRefCountPtr< FTaskBase >	Pimpl

Friends
template<int32 Index, typename ArrayType , typename FirstTaskType , typename... OtherTasksTypes>
void	PrerequisitesUnpacker (ArrayType &Array, FirstTaskType &FirstTask, OtherTasksTypes &... OtherTasks)
template<int32 Index, typename ArrayType , typename TaskType >
void	PrerequisitesUnpacker (ArrayType &Array, TaskType &FirstTask)
template<typename TaskCollectionType >
bool	TryRetractAndExecute (const TaskCollectionType &Tasks, FTimeout Timeout)
template<typename TaskCollectionType >
TArray< TaskTrace::FId >	GetTraceIds (const TaskCollectionType &Tasks)
template<typename TaskCollectionType >
bool	UE::Tasks::Wait (const TaskCollectionType &Tasks, FTimespan InTimeout)
template<typename TaskType >
void	UE::Tasks::AddNested (const TaskType &Nested)

Member Typedef Documentation

FTaskHandleId

using UE::Tasks::Private::FTaskHandle::FTaskHandleId = void

Constructor & Destructor Documentation

FTaskHandle() [1/2]

UE::Tasks::Private::FTaskHandle::FTaskHandle ( FTaskBase *  Other )

inlineexplicitprotected

FTaskHandle() [2/2]

UE::Tasks::Private::FTaskHandle::FTaskHandle ( )

default

Member Function Documentation

GetExtendedPriority()

EExtendedTaskPriority UE::Tasks::Private::FTaskHandle::GetExtendedPriority ( ) const

inline

GetPriority()

ETaskPriority UE::Tasks::Private::FTaskHandle::GetPriority ( ) const

inline

IsAwaitable()

bool UE::Tasks::Private::FTaskHandle::IsAwaitable ( ) const

inline

IsCompleted()

bool UE::Tasks::Private::FTaskHandle::IsCompleted ( ) const

inline

IsValid()

bool UE::Tasks::Private::FTaskHandle::IsValid ( ) const

inline

Launch() [1/2]

template<typename TaskBodyType >

void UE::Tasks::Private::FTaskHandle::Launch ( const TCHAR *  DebugName, TaskBodyType &&  TaskBody, ETaskPriority  Priority = ETaskPriority::Normal, EExtendedTaskPriority  ExtendedPriority = EExtendedTaskPriority::None, ETaskFlags  Flags = ETaskFlags::None  )

inline

Launch() [2/2]

template<typename TaskBodyType , typename PrerequisitesCollectionType >

void UE::Tasks::Private::FTaskHandle::Launch ( const TCHAR *  DebugName, TaskBodyType &&  TaskBody, PrerequisitesCollectionType &&  Prerequisites, ETaskPriority  Priority = ETaskPriority::Normal, EExtendedTaskPriority  ExtendedPriority = EExtendedTaskPriority::None, ETaskFlags  Flags = ETaskFlags::None  )

inline

operator!=()

bool UE::Tasks::Private::FTaskHandle::operator!= ( const FTaskHandle &  Other ) const

inline

operator==()

bool UE::Tasks::Private::FTaskHandle::operator== ( const FTaskHandle &  Other ) const

inline

TryRetractAndExecute()

bool UE::Tasks::Private::FTaskHandle::TryRetractAndExecute ( )

inline

Wait() [1/2]

bool UE::Tasks::Private::FTaskHandle::Wait ( ) const

inline

Wait() [2/2]

bool UE::Tasks::Private::FTaskHandle::Wait ( FTimespan  Timeout ) const

inline

Friends And Related Symbol Documentation

GetTraceIds

template<typename TaskCollectionType >

TArray< TaskTrace::FId > GetTraceIds ( const TaskCollectionType &  Tasks )

friend

PrerequisitesUnpacker [1/2]

template<int32 Index, typename ArrayType , typename FirstTaskType , typename... OtherTasksTypes>

void PrerequisitesUnpacker ( ArrayType &  Array, FirstTaskType &  FirstTask, OtherTasksTypes &...  OtherTasks  )

friend

PrerequisitesUnpacker [2/2]

template<int32 Index, typename ArrayType , typename TaskType >

void PrerequisitesUnpacker ( ArrayType &  Array, TaskType &  FirstTask  )

friend

TryRetractAndExecute

template<typename TaskCollectionType >

bool TryRetractAndExecute ( const TaskCollectionType &  Tasks, FTimeout  Timeout  )

friend

UE::Tasks::AddNested

template<typename TaskType >

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

friend

UE::Tasks::Wait

template<typename TaskCollectionType >

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

friend

Member Data Documentation

Pimpl

TRefCountPtr<FTaskBase> UE::Tasks::Private::FTaskHandle::Pimpl

protected

---

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

• Engine/Source/Runtime/Core/Public/Tasks/Task.h