LowLevelTasks Namespace Reference

Namespaces
namespace	LocalQueue_Impl
namespace	Private
namespace	Tasks_Impl
namespace	TTaskDelegate_Impl

Classes
struct	FLowLevelTasksBlockAllocationTag
class	FScheduler
class	FSchedulerTls
class	FTask
struct	FTlsValuesAllocator
class	TDeleter
class	TTaskDelegate
class	TTaskDelegate< ReturnType(ParamTypes...), TotalSize >

Typedefs
template<typename NodeType >
using	TAlignedArray = TArray< NodeType, TAlignedHeapAllocator< alignof(NodeType)> >

Enumerations
enum class	EQueuePreference { GlobalQueuePreference , LocalQueuePreference , DefaultPreference = LocalQueuePreference }
enum class	ETaskPriority : int8 {   High , Normal , Default = Normal , ForegroundCount ,   BackgroundHigh = ForegroundCount , BackgroundNormal , BackgroundLow , Count ,   Inherit }
enum class	ECancellationFlags : int8 { None = 0 << 0 , TryLaunchOnSuccess = 1 << 0 , PrelaunchCancellation = 1 << 1 , DefaultFlags = TryLaunchOnSuccess | PrelaunchCancellation }
enum class	ETaskFlags : int8 {   AllowNothing = 0 << 0 , AllowBusyWaiting = 1 << 0 , AllowCancellation = 1 << 1 , AllowEverything = AllowBusyWaiting | AllowCancellation ,   DefaultFlags = AllowEverything }
enum class	ETaskState : int8 {   ReadyState = 0 , CanceledFlag = 1 << 0 , ScheduledFlag = 1 << 1 , RunningFlag = 1 << 2 ,   ExpeditingFlag = 1 << 3 , ExpeditedFlag = 1 << 4 , CompletedFlag = 1 << 5 , Count = (1 << 6) - 1 ,   Ready = ReadyState , CanceledAndReady = Ready | CanceledFlag , Scheduled = Ready | ScheduledFlag , Canceled = CanceledAndReady | ScheduledFlag ,   Running = Scheduled | RunningFlag , CanceledAndRunning = Canceled | RunningFlag , Expediting = Running | ExpeditingFlag , Expedited = Expediting | ExpeditedFlag ,   Completed = Running | CompletedFlag , ExpeditedAndCompleted = Expedited | CompletedFlag , CanceledAndCompleted = CanceledAndRunning | CompletedFlag }

Functions
	DEFINE_LOG_CATEGORY (LowLevelTasks)
UE_FORCEINLINE_HINT bool	TryLaunch (FTask &Task, EQueuePreference QueuePreference=EQueuePreference::DefaultPreference, bool bWakeUpWorker=true)
	DECLARE_LOG_CATEGORY_EXTERN (LowLevelTasks, Log, All)
const TCHAR *	ToString (ETaskPriority Priority)
bool	ToTaskPriority (const TCHAR *PriorityStr, ETaskPriority &OutPriority)
	DECLARE_TS_MULTICAST_DELEGATE (FOversubscriptionLimitReached)

Typedef Documentation

TAlignedArray

template<typename NodeType >

using LowLevelTasks::TAlignedArray = typedef TArray<NodeType, TAlignedHeapAllocator<alignof(NodeType)> >

Enumeration Type Documentation

ECancellationFlags

enum class LowLevelTasks::ECancellationFlags : int8

strong

Enumerator
None
TryLaunchOnSuccess
PrelaunchCancellation
DefaultFlags

EQueuePreference

enum class LowLevelTasks::EQueuePreference

strong

Enumerator
GlobalQueuePreference
LocalQueuePreference
DefaultPreference

ETaskFlags

enum class LowLevelTasks::ETaskFlags : int8

strong

Enumerator
AllowNothing
AllowBusyWaiting
AllowCancellation
AllowEverything
DefaultFlags

ETaskPriority

enum class LowLevelTasks::ETaskPriority : int8

strong

Enumerator
High
Normal
Default
ForegroundCount
BackgroundHigh
BackgroundNormal
BackgroundLow
Count
Inherit

ETaskState

enum class LowLevelTasks::ETaskState : int8

strong

Enumerator
ReadyState
CanceledFlag
ScheduledFlag
RunningFlag
ExpeditingFlag
ExpeditedFlag
CompletedFlag
Count
Ready
CanceledAndReady
Scheduled
Canceled
Running
CanceledAndRunning
Expediting
Expedited
Completed
ExpeditedAndCompleted
CanceledAndCompleted

Function Documentation

DECLARE_LOG_CATEGORY_EXTERN()

LowLevelTasks::DECLARE_LOG_CATEGORY_EXTERN	(	LowLevelTasks	,
		Log	,
		All
	)

DECLARE_TS_MULTICAST_DELEGATE()

LowLevelTasks::DECLARE_TS_MULTICAST_DELEGATE

(

FOversubscriptionLimitReached

)

DEFINE_LOG_CATEGORY()

LowLevelTasks::DEFINE_LOG_CATEGORY

(

LowLevelTasks

)

ToString()

const TCHAR * LowLevelTasks::ToString ( ETaskPriority  Priority )

inline

ToTaskPriority()

bool LowLevelTasks::ToTaskPriority ( const TCHAR *  PriorityStr, ETaskPriority &  OutPriority  )

inline

TryLaunch()

UE_FORCEINLINE_HINT bool LowLevelTasks::TryLaunch	(	FTask &	Task,
		EQueuePreference	QueuePreference = EQueuePreference::DefaultPreference,
		bool	bWakeUpWorker = true
	)