UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::TGenericPlatformSharedMutex< MutexType > Class Template Reference

#include <GenericPlatformMutex.h>

Public Member Functions

 TGenericPlatformSharedMutex (const TGenericPlatformSharedMutex &)=delete
 
TGenericPlatformSharedMutexoperator= (const TGenericPlatformSharedMutex &)=delete
 
 TGenericPlatformSharedMutex ()=default
 
 ~TGenericPlatformSharedMutex ()=default
 
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

template<class MutexType>
class UE::TGenericPlatformSharedMutex< MutexType >

TGenericPlatformSharedMutex - Read/Write Mutex

  • Provides non-recursive Read/Write (or shared-exclusive) access.
  • As a fallback default for non implemented platforms, using a single mutex to provide complete single mutual exclusion - no separate Read/Write access.

Constructor & Destructor Documentation

◆ TGenericPlatformSharedMutex() [1/2]

template<class MutexType >
UE::TGenericPlatformSharedMutex< MutexType >::TGenericPlatformSharedMutex ( const TGenericPlatformSharedMutex< MutexType > &  )
delete

◆ TGenericPlatformSharedMutex() [2/2]

template<class MutexType >
UE::TGenericPlatformSharedMutex< MutexType >::TGenericPlatformSharedMutex ( )
default

◆ ~TGenericPlatformSharedMutex()

template<class MutexType >
UE::TGenericPlatformSharedMutex< MutexType >::~TGenericPlatformSharedMutex ( )
default

Member Function Documentation

◆ Lock()

template<class MutexType >
UE_FORCEINLINE_HINT void UE::TGenericPlatformSharedMutex< MutexType >::Lock ( )
inline

◆ LockShared()

template<class MutexType >
UE_FORCEINLINE_HINT void UE::TGenericPlatformSharedMutex< MutexType >::LockShared ( )
inline

◆ operator=()

template<class MutexType >
TGenericPlatformSharedMutex & UE::TGenericPlatformSharedMutex< MutexType >::operator= ( const TGenericPlatformSharedMutex< MutexType > &  )
delete

◆ TryLock()

template<class MutexType >
UE_FORCEINLINE_HINT bool UE::TGenericPlatformSharedMutex< MutexType >::TryLock ( )
inline

◆ TryLockShared()

template<class MutexType >
UE_FORCEINLINE_HINT bool UE::TGenericPlatformSharedMutex< MutexType >::TryLockShared ( )
inline

◆ Unlock()

template<class MutexType >
UE_FORCEINLINE_HINT void UE::TGenericPlatformSharedMutex< MutexType >::Unlock ( )
inline

◆ UnlockShared()

template<class MutexType >
UE_FORCEINLINE_HINT void UE::TGenericPlatformSharedMutex< MutexType >::UnlockShared ( )
inline

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