UE::FWindowsSystemWideMutex Class Reference

#include <WindowsPlatformMutex.h>

Public Member Functions
	FWindowsSystemWideMutex (const FWindowsSystemWideMutex &)=delete
FWindowsSystemWideMutex &	operator= (const FWindowsSystemWideMutex &)=delete
CORE_API	FWindowsSystemWideMutex (const FString &InName, FTimespan InTimeout=FTimespan::Zero())
CORE_API	~FWindowsSystemWideMutex ()
CORE_API bool	IsValid () const
CORE_API void	Release ()

Detailed Description

A system-wide mutex for Windows. Uses a named mutex.

Constructor & Destructor Documentation

FWindowsSystemWideMutex() [1/2]

UE::FWindowsSystemWideMutex::FWindowsSystemWideMutex ( const FWindowsSystemWideMutex &  )

delete

FWindowsSystemWideMutex() [2/2]

UE::FWindowsSystemWideMutex::FWindowsSystemWideMutex ( const FString &  InName, FTimespan  InTimeout = FTimespan::Zero()  )

explicit

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

~FWindowsSystemWideMutex()

UE::FWindowsSystemWideMutex::~FWindowsSystemWideMutex

(

)

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

Member Function Documentation

IsValid()

bool UE::FWindowsSystemWideMutex::IsValid

(

)

const

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

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

delete

Release()

void UE::FWindowsSystemWideMutex::Release

(

)

Releases system-wide mutex if it is currently owned.

---

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

• Engine/Source/Runtime/Core/Public/Windows/WindowsPlatformMutex.h
• Engine/Source/Runtime/Core/Private/Windows/WindowsPlatformMutex.cpp