UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::FRecursiveMutex Class Referencefinal

#include <RecursiveMutex.h>

Public Member Functions

constexpr FRecursiveMutex ()=default
 
 FRecursiveMutex (const FRecursiveMutex &)=delete
 
FRecursiveMutexoperator= (const FRecursiveMutex &)=delete
 
bool IsLocked () const
 
UE_API bool TryLock ()
 
UE_API void Lock ()
 
UE_API void Unlock ()
 

Detailed Description

An eight-byte mutex that is not fair and supports recursive locking.

Prefer FMutex when recursive locking is not required.

Constructor & Destructor Documentation

◆ FRecursiveMutex() [1/2]

constexpr UE::FRecursiveMutex::FRecursiveMutex ( )
constexprdefault

◆ FRecursiveMutex() [2/2]

UE::FRecursiveMutex::FRecursiveMutex ( const FRecursiveMutex )
delete

Member Function Documentation

◆ IsLocked()

bool UE::FRecursiveMutex::IsLocked ( ) const
inline

◆ Lock()

void UE::FRecursiveMutex::Lock ( )

◆ operator=()

FRecursiveMutex & UE::FRecursiveMutex::operator= ( const FRecursiveMutex )
delete

◆ TryLock()

bool UE::FRecursiveMutex::TryLock ( )

◆ Unlock()

void UE::FRecursiveMutex::Unlock ( )

The documentation for this class was generated from the following files: