Module |
|
Header |
/Engine/Source/Runtime/Core/Public/HAL/RunnableThread.h |
Include |
#include "HAL/RunnableThread.h" |
class FRunnableThread
Interface for runnable threads.
This interface specifies the methods used to manage a thread's life cycle.
Name | Description | ||
---|---|---|---|
|
Runnable |
The runnable object to execute on this thread. |
|
|
ThreadAffinityMask |
The Affinity to run the thread with. |
|
|
ThreadID |
ID set during thread creation. |
|
|
FEvent * |
ThreadInitSyncEvent |
Sync event to make sure that Init() has been completed before allowing the main thread to continue. |
|
ThreadName |
Holds the name of the thread. |
|
|
ThreadPriority |
The priority to run the thread at. |
|
|
TlsInstances |
An array of FTlsAutoCleanup based instances that needs to be deleted before the thread will die. |
Name | Description | |
---|---|---|
|
FRunnableThread() |
Default constructor. |
Name | Description | |
---|---|---|
|
~FRunnableThread() |
Virtual destructor |
Name | Description | ||
---|---|---|---|
|
FRunnableThr... |
Create ( |
Factory method to create a thread with the specified stack size and thread priority. |
|
CreateInternal ( |
Creates the thread with the specified stack size and thread priority. |
|
|
FreeTls() |
Deletes all FTlsAutoCleanup objects created for this thread. |
|
|
FRunnableThr... |
GetRunnableThread() |
|
|
const uint32 |
GetThreadID() |
Thread ID for this thread |
|
const FStrin... |
GetThreadName() |
Retrieves the given name of the thread |
|
EThreadPrior... |
GetThreadPriority() |
Returns the runnable's thread priority |
|
GetTlsSlot() |
Gets a new Tls slot for storing the runnable thread pointer. |
|
|
Kill ( |
Tells the thread to exit. |
|
|
SetThreadPriority ( |
Changes the thread priority of the currently running thread |
|
|
SetTls() |
Stores this instance in the runnable thread TLS slot. |
|
|
Suspend ( |
Tells the thread to either pause execution or resume depending on the passed in value. |
|
|
WaitForCompletion() |
Halts the caller until this thread is has completed its work. |
Name |
Description |
|
---|---|---|
|
ThreadType |
List of unique thread types we can create |
Name |
Description |
---|---|
RunnableTlsSlot |
Index of TLS slot for FRunnableThread pointer. |