UE::FSharedMutex Class Reference

#include <SharedMutex.h>

Classes
struct	FParams

Public Member Functions
constexpr	FSharedMutex ()=default
	FSharedMutex (const FSharedMutex &)=delete
FSharedMutex &	operator= (const FSharedMutex &)=delete
bool	IsLocked () const
bool	TryLock ()
void	Lock ()
void	Unlock ()
bool	IsLockShared () const
bool	TryLockShared ()
void	LockShared ()
void	UnlockShared ()

Detailed Description

A four-byte shared mutex that is not fair and does not support recursive locking.

Prefer FMutex when shared locking is not required. All new shared locks will wait when any thread is waiting to take an exclusive lock. An exclusive lock and a shared lock may not be simultaneously held by the same thread.

Constructor & Destructor Documentation

FSharedMutex() [1/2]

constexpr UE::FSharedMutex::FSharedMutex ( )

constexprdefault

FSharedMutex() [2/2]

UE::FSharedMutex::FSharedMutex ( const FSharedMutex &  )

delete

Member Function Documentation

IsLocked()

bool UE::FSharedMutex::IsLocked ( ) const

inline

IsLockShared()

bool UE::FSharedMutex::IsLockShared ( ) const

inline

Lock()

void UE::FSharedMutex::Lock ( )

inline

LockShared()

void UE::FSharedMutex::LockShared ( )

inline

operator=()

FSharedMutex & UE::FSharedMutex::operator= ( const FSharedMutex &  )

delete

TryLock()

bool UE::FSharedMutex::TryLock ( )

inline

TryLockShared()

bool UE::FSharedMutex::TryLockShared ( )

inline

Unlock()

void UE::FSharedMutex::Unlock ( )

inline

UnlockShared()

void UE::FSharedMutex::UnlockShared ( )

inline

---

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

• Engine/Source/Runtime/Core/Public/Async/SharedMutex.h
• Engine/Source/Runtime/Core/Private/Async/SharedMutex.cpp