TDynamicUniqueLock | Unreal Engine 5.7 Documentation

A mutex ownership wrapper that allows dynamic locking, unlocking, and deferred locking.

LockType must contain Lock() and Unlock() functions.

Use with mutex types like FMutex and FRecursiveMutex.


Name	TDynamicUniqueLock
Type	class
Header File	/Engine/Source/Runtime/Core/Public/Async/UniqueLock.h
Include Path	#include "Async/UniqueLock.h"

Syntax

template<typename LockType>  
class TDynamicUniqueLock

Name	Remarks	Include Path
TDynamicUniqueLock ()		Async/UniqueLock.h
TDynamicUniqueLock ( const TDynamicUniqueLock& )		Async/UniqueLock.h
TDynamicUniqueLock ( LockType& Lock )	Wrap a mutex and lock it.	Async/UniqueLock.h
TDynamicUniqueLock ( TDynamicUniqueLock&& Other )	Move from another lock, transferring any ownership to this lock.	Async/UniqueLock.h
TDynamicUniqueLock ( LockType& Lock, FDeferLock )	Wrap a mutex without locking it.	Async/UniqueLock.h

Name	Remarks	Include Path	Unreal Specifiers
~TDynamicUniqueLock()	Unlock the mutex if locked.	Async/UniqueLock.h

Name	Type	Remarks	Include Path	Unreal Specifiers
bLocked	bool		Async/UniqueLock.h
Mutex	LockType *		Async/UniqueLock.h

Name	Remarks	Include Path
void Lock()	Lock the associated mutex. This lock must have a mutex and must not be locked.	Async/UniqueLock.h
bool OwnsLock()	Returns true if this lock has its associated mutex locked.	Async/UniqueLock.h
void Unlock()	Unlock the associated mutex. This lock must have a mutex and must be locked.	Async/UniqueLock.h

Name	Remarks	Include Path
operator bool()	Returns true if this lock has its associated mutex locked.	Async/UniqueLock.h
TDynamicUniqueLock & operator= ( const TDynamicUniqueLock& )		Async/UniqueLock.h
TDynamicUniqueLock & operator= ( TDynamicUniqueLock&& Other )	Move from another lock, transferring any ownership to this lock, and unlocking the previous mutex if locked.	Async/UniqueLock.h