Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > HAL > FThreadHeartBeat

Light Theme

Dark Theme

FThreadHeartBeat

Thread heartbeat check class. Used by crash handling code to check for hangs.

Windows

MacOS

Linux

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

	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
FThreadHeart...	Get()	Gets the heartbeat singleton
double	GetHangDuration()	Get hang duration threshold.
uint32	GetLastHungThreadId()	Get the Id of the last thread to trigger the hang detector.
uint32	GetLastStuckThreadId()	Get the Id of the last thread to pass the stuck thread time.
FThreadHeart...	GetNoInit()	Gets the heartbeat singleton
FOnThreadStu...	GetOnThreadStuck()	Get delegate for callback on stuck or unstuck thread.
FOnThreadUns...	GetOnThreadUnstuck()
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	KillHeartBeat()	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, double TimeToReachCheckpoint )	Called from a thread to register a checkpoint to be monitored
void	MonitorFunctionEnd()	Called by a thread when a function has completed and no longer needs to be monitored
void	MonitorFunctionStart()	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

	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.

Name

Description