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

#include <GenericPlatformMutex.h>

Public Member Functions

 FPlatformSystemWideMutexNotImplemented (const FPlatformSystemWideMutexNotImplemented &)=delete
 
FPlatformSystemWideMutexNotImplementedoperator= (const FPlatformSystemWideMutexNotImplemented &)=delete
 
CORE_API FPlatformSystemWideMutexNotImplemented (const FString &Name, FTimespan Timeout=FTimespan::Zero())
 
 ~FPlatformSystemWideMutexNotImplemented ()=default
 
bool IsValid () const
 
void Release ()
 

Detailed Description

Platforms that don't need a working FPlatformSystemWideMutex can alias this one.

Constructor & Destructor Documentation

◆ FPlatformSystemWideMutexNotImplemented() [1/2]

UE::FPlatformSystemWideMutexNotImplemented::FPlatformSystemWideMutexNotImplemented ( const FPlatformSystemWideMutexNotImplemented )
delete

◆ FPlatformSystemWideMutexNotImplemented() [2/2]

UE::FPlatformSystemWideMutexNotImplemented::FPlatformSystemWideMutexNotImplemented ( const FString &  Name,
FTimespan  Timeout = FTimespan::Zero() 
)
explicit

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

◆ ~FPlatformSystemWideMutexNotImplemented()

UE::FPlatformSystemWideMutexNotImplemented::~FPlatformSystemWideMutexNotImplemented ( )
default

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

Member Function Documentation

◆ IsValid()

bool UE::FPlatformSystemWideMutexNotImplemented::IsValid ( ) const
inline

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=()

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

◆ Release()

void UE::FPlatformSystemWideMutexNotImplemented::Release ( )
inline

Releases system-wide mutex if it is currently owned.


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