Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FWindowsSystemWideCriticalSection Class Reference

#include <WindowsCriticalSection.h>

Public Member Functions

 FWindowsSystemWideCriticalSection (const class FString &InName, FTimespan InTimeout=FTimespan::Zero())
 
 ~FWindowsSystemWideCriticalSection ()
 
bool IsValid () const
 
void Release ()
 

Private Member Functions

 FWindowsSystemWideCriticalSection (const FWindowsSystemWideCriticalSection &)
 
FWindowsSystemWideCriticalSectionoperator= (const FWindowsSystemWideCriticalSection &)
 

Private Attributes

Windows::HANDLE Mutex
 

Detailed Description

System-Wide Critical Section for windows using mutex

Definition at line 77 of file WindowsCriticalSection.h.

Constructor & Destructor Documentation

◆ FWindowsSystemWideCriticalSection() [1/2]

FWindowsSystemWideCriticalSection::FWindowsSystemWideCriticalSection ( const class FString & InName,
FTimespan InTimeout = FTimespan::Zero() )
explicit

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

◆ ~FWindowsSystemWideCriticalSection()

FWindowsSystemWideCriticalSection::~FWindowsSystemWideCriticalSection ( )

Destructor releases system-wide critical section if it is currently owned

◆ FWindowsSystemWideCriticalSection() [2/2]

FWindowsSystemWideCriticalSection::FWindowsSystemWideCriticalSection ( const FWindowsSystemWideCriticalSection & )
private

Member Function Documentation

◆ IsValid()

bool FWindowsSystemWideCriticalSection::IsValid ( ) const

Does the calling thread have ownership of the system-wide critical section?

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

FWindowsSystemWideCriticalSection & FWindowsSystemWideCriticalSection::operator= ( const FWindowsSystemWideCriticalSection & )
private

◆ Release()

void FWindowsSystemWideCriticalSection::Release ( )

Releases system-wide critical section if it is currently owned

Member Data Documentation

◆ Mutex

Windows::HANDLE FWindowsSystemWideCriticalSection::Mutex
private

Definition at line 101 of file WindowsCriticalSection.h.


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