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

#include <WindowsPlatformMutex.h>

Public Member Functions

 FWindowsSharedMutex (const FWindowsSharedMutex &)=delete
 
FWindowsSharedMutexoperator= (const FWindowsSharedMutex &)=delete
 
 FWindowsSharedMutex ()=default
 
 ~FWindowsSharedMutex ()
 
UE_FORCEINLINE_HINT bool TryLock ()
 
UE_FORCEINLINE_HINT void Lock ()
 
UE_FORCEINLINE_HINT void Unlock ()
 
UE_FORCEINLINE_HINT bool TryLockShared ()
 
UE_FORCEINLINE_HINT void LockShared ()
 
UE_FORCEINLINE_HINT void UnlockShared ()
 

Detailed Description

A shared (read/write) mutex that does not support recursive locking.

Prefer FSharedMutex.

SRWLOCK: https://learn.microsoft.com/en-us/windows/win32/sync/slim-reader-writer&ndash;srw&ndash;locks

Constructor & Destructor Documentation

◆ FWindowsSharedMutex() [1/2]

UE::FWindowsSharedMutex::FWindowsSharedMutex ( const FWindowsSharedMutex )
delete

◆ FWindowsSharedMutex() [2/2]

UE::FWindowsSharedMutex::FWindowsSharedMutex ( )
default

◆ ~FWindowsSharedMutex()

UE::FWindowsSharedMutex::~FWindowsSharedMutex ( )
inline

Member Function Documentation

◆ Lock()

UE_FORCEINLINE_HINT void UE::FWindowsSharedMutex::Lock ( )
inline

◆ LockShared()

UE_FORCEINLINE_HINT void UE::FWindowsSharedMutex::LockShared ( )
inline

◆ operator=()

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

◆ TryLock()

UE_FORCEINLINE_HINT bool UE::FWindowsSharedMutex::TryLock ( )
inline

◆ TryLockShared()

UE_FORCEINLINE_HINT bool UE::FWindowsSharedMutex::TryLockShared ( )
inline

◆ Unlock()

UE_FORCEINLINE_HINT void UE::FWindowsSharedMutex::Unlock ( )
inline

◆ UnlockShared()

UE_FORCEINLINE_HINT void UE::FWindowsSharedMutex::UnlockShared ( )
inline

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