LowLevelTasks::FScheduler Class Reference

#include <Scheduler.h>

Inheritance diagram for LowLevelTasks::FScheduler:

Public Member Functions
CORE_API void	StartWorkers (uint32 NumForegroundWorkers=0, uint32 NumBackgroundWorkers=0, FThread::EForkable IsForkable=FThread::NonForkable, EThreadPriority InWorkerPriority=EThreadPriority::TPri_Normal, EThreadPriority InBackgroundPriority=EThreadPriority::TPri_BelowNormal, uint64 InWorkerAffinity=0, uint64 InBackgroundAffinity=0)
CORE_API void	StopWorkers (bool DrainGlobalQueue=true)
CORE_API void	RestartWorkers (uint32 NumForegroundWorkers=0, uint32 NumBackgroundWorkers=0, FThread::EForkable IsForkable=FThread::NonForkable, EThreadPriority WorkerPriority=EThreadPriority::TPri_Normal, EThreadPriority BackgroundPriority=EThreadPriority::TPri_BelowNormal, uint64 InWorkerAffinity=0, uint64 InBackgroundAffinity=0)
bool	TryLaunch (FTask &Task, EQueuePreference QueuePreference=EQueuePreference::DefaultPreference, bool bWakeUpWorker=true)
uint32	GetNumWorkers () const
uint32	GetMaxNumWorkers () const
EThreadPriority	GetWorkerPriority () const
EThreadPriority	GetBackgroundPriority () const
CORE_API bool	IsOversubscriptionLimitReached (ETaskPriority TaskPriority) const
CORE_API FOversubscriptionLimitReached &	GetOversubscriptionLimitReachedEvent ()
	FScheduler ()=default
	~FScheduler ()
Public Member Functions inherited from LowLevelTasks::FSchedulerTls
CORE_API bool	IsWorkerThread () const

Static Public Member Functions
static FScheduler &	Get ()

Friends
class	FOversubscriptionScope

Additional Inherited Members
Protected Types inherited from LowLevelTasks::FSchedulerTls
enum class	EWorkerType { None , Background , Foreground }
using	FQueueRegistry = Private::TLocalQueueRegistry<>
using	FLocalQueueType = FQueueRegistry::TLocalQueue
Protected Member Functions inherited from LowLevelTasks::FSchedulerTls
CORE_API bool	HasPendingWakeUp () const
Static Protected Member Functions inherited from LowLevelTasks::FSchedulerTls
static FTlsValues &	GetTlsValuesRef ()

Constructor & Destructor Documentation

FScheduler()

LowLevelTasks::FScheduler::FScheduler ( )

default

~FScheduler()

LowLevelTasks::FScheduler::~FScheduler ( )

inline

Member Function Documentation

Get()

FScheduler & LowLevelTasks::FScheduler::Get ( )

inlinestatic

GetBackgroundPriority()

EThreadPriority LowLevelTasks::FScheduler::GetBackgroundPriority ( ) const

inline

GetMaxNumWorkers()

uint32 LowLevelTasks::FScheduler::GetMaxNumWorkers ( ) const

inline

GetNumWorkers()

uint32 LowLevelTasks::FScheduler::GetNumWorkers ( ) const

inline

GetOversubscriptionLimitReachedEvent()

FOversubscriptionLimitReached & LowLevelTasks::FScheduler::GetOversubscriptionLimitReachedEvent

(

)

GetWorkerPriority()

EThreadPriority LowLevelTasks::FScheduler::GetWorkerPriority ( ) const

inline

IsOversubscriptionLimitReached()

bool LowLevelTasks::FScheduler::IsOversubscriptionLimitReached

(

ETaskPriority

TaskPriority

)

const

RestartWorkers()

void LowLevelTasks::FScheduler::RestartWorkers	(	uint32	NumForegroundWorkers = 0,
		uint32	NumBackgroundWorkers = 0,
		FThread::EForkable	IsForkable = FThread::NonForkable,
		EThreadPriority	WorkerPriority = EThreadPriority::TPri_Normal,
		EThreadPriority	BackgroundPriority = EThreadPriority::TPri_BelowNormal,
		uint64	InWorkerAffinity = 0,
		uint64	InBackgroundAffinity = 0
	)

StartWorkers()

void LowLevelTasks::FScheduler::StartWorkers	(	uint32	NumForegroundWorkers = 0,
		uint32	NumBackgroundWorkers = 0,
		FThread::EForkable	IsForkable = FThread::NonForkable,
		EThreadPriority	InWorkerPriority = EThreadPriority::TPri_Normal,
		EThreadPriority	InBackgroundPriority = EThreadPriority::TPri_BelowNormal,
		uint64	InWorkerAffinity = 0,
		uint64	InBackgroundAffinity = 0
	)

StopWorkers()

void LowLevelTasks::FScheduler::StopWorkers

(

bool

DrainGlobalQueue = true

)

TryLaunch()

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

inline

Friends And Related Symbol Documentation

FOversubscriptionScope

friend class FOversubscriptionScope

friend

---

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

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