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

#include <MacPlatformMutex.h>

Public Member Functions

 FMacSystemWideMutex (const FMacSystemWideMutex &)=delete
 
FMacSystemWideMutexoperator= (const FMacSystemWideMutex &)=delete
 
CORE_API FMacSystemWideMutex (const FString &InName, FTimespan InTimeout=FTimespan::Zero())
 
CORE_API ~FMacSystemWideMutex ()
 
CORE_API bool IsValid () const
 
CORE_API void Release ()
 

Detailed Description

A system-wide mutex for Mac. Uses exclusive file locking.

Constructor & Destructor Documentation

◆ FMacSystemWideMutex() [1/2]

UE::FMacSystemWideMutex::FMacSystemWideMutex ( const FMacSystemWideMutex )
delete

◆ FMacSystemWideMutex() [2/2]

UE::FMacSystemWideMutex::FMacSystemWideMutex ( const FString &  InName,
FTimespan  InTimeout = FTimespan::Zero() 
)
explicit

Construct a named, system-wide mutex and attempt to get access/ownership of it.

◆ ~FMacSystemWideMutex()

UE::FMacSystemWideMutex::~FMacSystemWideMutex ( )

Destructor releases system-wide mutex if it is currently owned.

Member Function Documentation

◆ IsValid()

bool UE::FMacSystemWideMutex::IsValid ( ) const

Does the calling thread have ownership of the system-wide mutex?

Returns
True if obtained. WARNING: Returns true for an owned but previously abandoned locks so shared resources can be in undetermined states. You must handle shared data robustly.

◆ operator=()

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

◆ Release()

void UE::FMacSystemWideMutex::Release ( )

Releases system-wide mutex if it is currently owned.


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