UE::FUnixSystemWideMutex Class Reference

#include <UnixPlatformMutex.h>

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

Detailed Description

A system-wide mutex for Unix. Uses exclusive file locking.

Constructor & Destructor Documentation

FUnixSystemWideMutex() [1/2]

UE::FUnixSystemWideMutex::FUnixSystemWideMutex ( const FUnixSystemWideMutex &  )

delete

FUnixSystemWideMutex() [2/2]

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

explicit

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

~FUnixSystemWideMutex()

UE::FUnixSystemWideMutex::~FUnixSystemWideMutex

(

)

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

Member Function Documentation

IsValid()

bool UE::FUnixSystemWideMutex::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=()

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

delete

Release()

void UE::FUnixSystemWideMutex::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/Unix/UnixPlatformMutex.h
• Engine/Source/Runtime/Core/Private/Unix/UnixPlatformMutex.cpp