Navigation
API > API/Runtime > API/Runtime/Core
| Name | FGameThreadHitchHeartBeatThreaded |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/HAL/ThreadHeartBeat.h |
| Include Path | #include "HAL/ThreadHeartBeat.h" |
Syntax
class FGameThreadHitchHeartBeatThreaded : public FRunnable
Inheritance Hierarchy
- FRunnable → FGameThreadHitchHeartBeatThreaded
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FGameThreadHitchHeartBeatThreaded() |
HAL/ThreadHeartBeat.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FGameThreadHitchHeartBeatThreaded() |
HAL/ThreadHeartBeat.h |
Enums
Public
| Name | Remarks |
|---|---|
| EConstants |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Singleton | FGameThreadHitchHeartBeatThreaded * | HAL/ThreadHeartBeat.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Clock | FThreadHeartBeatClock | HAL/ThreadHeartBeat.h | ||
| HeartBeatCritical | FCriticalSection | Synch object for the heartbeat | HAL/ThreadHeartBeat.h | |
| StopTaskCounter | FThreadSafeCounter | Stops this thread | HAL/ThreadHeartBeat.h | |
| Thread | FRunnableThread * | Thread to run the worker FRunnable on | HAL/ThreadHeartBeat.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void FrameStart
(
bool bSkipThisFrame |
Called at the start of a frame to register the time we are looking to detect a hitch | HAL/ThreadHeartBeat.h | |
double GetCurrentTime() |
HAL/ThreadHeartBeat.h | ||
double GetFrameStartTime() |
HAL/ThreadHeartBeat.h | ||
void InitSettings() |
Update settings from command line or ini | HAL/ThreadHeartBeat.h | |
bool IsStartedSuspended() |
Check if started suspended. | HAL/ThreadHeartBeat.h | |
void PostFork() |
HAL/ThreadHeartBeat.h | ||
void Restart() |
No-op, used in FUnixSignalGameHitchHeartBeat. | HAL/ThreadHeartBeat.h | |
void ResumeHeartBeat() |
Resume heartbeat hitch detection. Call only after first calling SuspendHeartBeat. | HAL/ThreadHeartBeat.h | |
void SuspendHeartBeat() |
Suspend heartbeat hitch detection. Must call ResumeHeartBeat later to resume. | HAL/ThreadHeartBeat.h |
Overridden from FRunnable
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool Init () |
Initializes the runnable object. | HAL/ThreadHeartBeat.h | |
virtual uint32 Run () |
Runs the runnable object. | HAL/ThreadHeartBeat.h | |
virtual void Stop () |
Stops the runnable object.This is called if a thread is requested to terminate early. | HAL/ThreadHeartBeat.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FGameThreadHitchHeartBeatThreaded & Get() |
Gets the heartbeat singleton | HAL/ThreadHeartBeat.h | |
static FGameThreadHitchHeartBeatThreaded * GetNoInit() |
HAL/ThreadHeartBeat.h |