1. Epic GamesDeveloper
  3. FRunnableThread

FRunnableThread

Interface for runnable threads.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/HAL

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/HAL/RunnableThread.h
Include #include "HAL/RunnableThread.h"

Syntax

class FRunnableThread

Remarks

Interface for runnable threads.

This interface specifies the methods used to manage a thread's life cycle.

Variables

  Type Name Description
Protected variable FRunnable * Runnable The runnable object to execute on this thread.
Protected variable uint64 ThreadAffinityMask The Affinity to run the thread with.
Protected variable uint32 ThreadID ID set during thread creation.
Protected variable FEvent * ThreadInitSyncEvent Sync event to make sure that Init() has been completed before allowing the main thread to continue.
Protected variable FString ThreadName Holds the name of the thread.
Protected variable EThreadPriority ThreadPriority The priority to run the thread at.

Constructors

  Type Name Description
Public function   Default constructor.

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function Static FRunnableThread *

Create ( FRunnable* InRunnable,
const TCHAR* ThreadName,
uint32 InStackSize,
EThreadPriority InThreadPri,
uint64 InThreadAffinityMask,
EThreadCreateFlags InCreateFlags
)

 Factory method to create a thread with the specified stack size and thread priority.
Protected function bool

CreateInternal ( FRunnable* InRunnable,
const TCHAR* InThreadName,
uint32 InStackSize,
EThreadPriority InThreadPri,
uint64 InThreadAffinityMask,
EThreadCreateFlags InCreateFlags
)

 Creates the thread with the specified stack size and thread priority.
Protected function void

FreeTls ()

 Deletes all FTlsAutoCleanup objects created for this thread.
Public function Static FRunnableThread *  
Public function Const const uint32 Thread ID for this thread
Public function Const const FString & Retrieves the given name of the thread
Public function Const EThreadPriority Returns the runnable's thread priority
Public function Virtual Const FRunnableThread::ThreadType Returns the type of thread this is
Public function Static uint32 Gets a new Tls slot for storing the runnable thread pointer.
Public function bool

Kill ( bool bShouldWait
)

 Tells the thread to exit.
Public function Virtual bool

SetThreadAffinity ( const FThreadAffinity& Affinity
)

 Changes the thread affinity of the currently running thread
Public function void Changes the thread priority of the currently running thread
Protected function void

SetTls ()

 Stores this instance in the runnable thread TLS slot.
Public function void

Suspend ( bool bShouldPause
)

 Tells the thread to either pause execution or resume depending on the passed in value.
Public function void Halts the caller until this thread is has completed its work.

Enums

  Type Name Description
Public enum ThreadType List of unique thread types we can create  

Constants

Name Description
RunnableTlsSlot Index of TLS slot for FRunnableThread pointer.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page