Navigation
API > API/Runtime > API/Runtime/Core
Interface for queued thread pools.
This interface is used by all queued thread pools. It used as a callback by FQueuedThreads and is used to queue asynchronous work for callers.
| Name | FQueuedThreadPool |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Misc/QueuedThreadPool.h |
| Include Path | #include "Misc/QueuedThreadPool.h" |
Syntax
class FQueuedThreadPool
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FQueuedThreadPool() |
Misc/QueuedThreadPool.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FQueuedThreadPool() |
Misc/QueuedThreadPool.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| OverrideStackSize | uint32 | Stack size for threads created for the thread pool. | Misc/QueuedThreadPool.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddQueuedWork
(
IQueuedWork* InQueuedWork, |
Checks to see if there is a thread available to perform the task. | Misc/QueuedThreadPool.h | |
bool Create
(
uint32 InNumQueuedThreads, |
Creates the thread pool with the specified number of threads | Misc/QueuedThreadPool.h | |
virtual bool CreateForkable
(
uint32 InNumQueuedThreads, |
Creates the thread pool with the specified number of forkable threads (see FForkProcessHelper) | Misc/QueuedThreadPool.h | |
void Destroy() |
Tells the pool to clean up all background threads | Misc/QueuedThreadPool.h | |
int32 GetNumThreads() |
Get the number of queued threads | Misc/QueuedThreadPool.h | |
bool RetractQueuedWork
(
IQueuedWork* InQueuedWork |
Attempts to retract a previously queued task. | Misc/QueuedThreadPool.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FQueuedThreadPool * Allocate() |
Allocates a thread pool | Misc/QueuedThreadPool.h |