FWindowsCriticalSection Class Reference

#include <WindowsCriticalSection.h>

Collaboration diagram for FWindowsCriticalSection:

Public Member Functions
	FWindowsCriticalSection (const FWindowsCriticalSection &)=delete
FWindowsCriticalSection &	operator= (const FWindowsCriticalSection &)=delete
FORCEINLINE	FWindowsCriticalSection ()
FORCEINLINE	~FWindowsCriticalSection ()
FORCEINLINE void	Lock ()
FORCEINLINE bool	TryLock ()
FORCEINLINE void	Unlock ()

Private Attributes
Windows::CRITICAL_SECTION	CriticalSection

Detailed Description

This is the Windows version of a critical section. It uses an aggregate CRITICAL_SECTION to implement its locking.

Definition at line 15 of file WindowsCriticalSection.h.

Constructor & Destructor Documentation

FWindowsCriticalSection() [1/2]

FWindowsCriticalSection::FWindowsCriticalSection ( const FWindowsCriticalSection & )

delete

FWindowsCriticalSection() [2/2]

FORCEINLINE FWindowsCriticalSection::FWindowsCriticalSection ( )

inline

Constructor that initializes the aggregated critical section

Definition at line 24 of file WindowsCriticalSection.h.

Here is the call graph for this function:

~FWindowsCriticalSection()

FORCEINLINE FWindowsCriticalSection::~FWindowsCriticalSection ( )

inline

Destructor cleaning up the critical section

Definition at line 34 of file WindowsCriticalSection.h.

Here is the call graph for this function:

Member Function Documentation

Lock()

FORCEINLINE void FWindowsCriticalSection::Lock ( )

inline

Locks the critical section

Definition at line 42 of file WindowsCriticalSection.h.

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

FWindowsCriticalSection & FWindowsCriticalSection::operator= ( const FWindowsCriticalSection & )

delete

TryLock()

FORCEINLINE bool FWindowsCriticalSection::TryLock ( )

inline

Attempt to take a lock and returns whether or not a lock was taken.

Returns

true if a lock was taken, false otherwise.

Definition at line 52 of file WindowsCriticalSection.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Unlock()

FORCEINLINE void FWindowsCriticalSection::Unlock ( )

inline

Releases the lock on the critical section

Definition at line 64 of file WindowsCriticalSection.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

CriticalSection

Windows::CRITICAL_SECTION FWindowsCriticalSection::CriticalSection

private

The windows specific critical section

Definition at line 73 of file WindowsCriticalSection.h.

---

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

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Windows/WindowsCriticalSection.h