Navigation
Unreal Engine C++ API Reference > Runtime > Core > HAL
Inheritance Hierarchy
- FRunnable
- FThreadHeartBeat
References
| Module | Core |
| Header | /Engine/Source/Runtime/Core/Public/HAL/ThreadHeartBeat.h |
| Include | #include "HAL/ThreadHeartBeat.h" |
Syntax
class FThreadHeartBeat : public FRunnable
Remarks
Thread heartbeat check class. Used by crash handling code to check for hangs.
Constructors
No constructors are accessible with public or protected access.
Destructors
No destructors are accessible with public or protected access.
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
uint32 | CheckCheckpointHeartBeat
(
double& OutHangDuration |
Called by a supervising thread to check all checkpoints forward progress |
 |
uint32 | CheckFunctionHeartBeat
(
double& OutHangDuration |
Called by a supervising thread to check all function calls' being monitored health |
 |
uint32 | CheckHeartBeat
(
double& OutHangDuration |
Called by a supervising thread to check the threads' health |
  |
FThreadHeartBeat & | Get () |
Gets the heartbeat singleton |
  |
double | Get hang duration threshold. | |
  |
uint32 | Get the Id of the last thread to trigger the hang detector. | |
  |
uint32 | Get the Id of the last thread to pass the stuck thread time. | |
  |
FThreadHeartBeat * | GetNoInit () |
Gets the heartbeat singleton |
 |
FOnHangDelegate & | Get delegate for callback on hang. | |
 |
FOnThreadStuck & | Get delegate for callback on stuck or unstuck thread. | |
 |
FOnThreadUnstuck & | ||
 |
void | HeartBeat
(
bool bReadConfig |
Called from a thread once per frame to update the heartbeat time |
 |
bool | IsBeating () |
Returns true/false if this thread is currently performing heartbeat monitoring |
 |
void | Called by a thread when it's no longer expecting to be ticked | |
 |
void | MonitorCheckpointEnd
(
FName CheckPoint |
Called from a thread when a checkpoint has ended |
 |
void | MonitorCheckpointStart
(
FName EndCheckPoint, |
Called from a thread to register a checkpoint to be monitored |
 |
void | Called by a thread when a function has completed and no longer needs to be monitored | |
 |
void | Called from a thread once on entry to a function to be monitored | |
 |
void | PresentFrame () |
Called from the rendering or RHI thread when the platform RHI presents a frame (supported platforms only). |
 |
void | ResumeHeartBeat
(
bool bAllThreads |
Resume heartbeat measuring for the current thread |
 |
void | SetDurationMultiplier
(
double NewMultiplier |
Sets a multiplier to the hang duration (>= 1.0). |
 |
void | Start () |
Begin measuring heartbeat |
 |
void | SuspendHeartBeat
(
bool bAllThreads |
Suspend heartbeat measuring for the current thread if the thread has already had a heartbeat |
Overridden from FRunnable
| Type | Name | Description | |
|---|---|---|---|
  |
bool | Init () |
Initializes the runnable object. |
  |
uint32 | Run () |
Runs the runnable object. |
  |
void | Stop () |
Stops the runnable object.This is called if a thread is requested to terminate early. |
Enums
| Type | Name | Description | |
|---|---|---|---|
 |
EConstants |
Constants
| Name | Description |
|---|---|
| Singleton |