FScopeUnlock Class Reference

#include <ScopeLock.h>

Collaboration diagram for FScopeUnlock:

Public Member Functions
UE_NODISCARD_CTOR	FScopeUnlock (FCriticalSection *InSynchObject)
	~FScopeUnlock ()

Private Member Functions
	FScopeUnlock ()
	FScopeUnlock (const FScopeUnlock &InScopeLock)
FScopeUnlock &	operator= (FScopeUnlock &InScopeLock)

Private Attributes
FCriticalSection *	SynchObject

Detailed Description

Implements a scope unlock.

This is a utility class that handles scope level unlocking. It's very useful to allow access to a protected object when you are sure it can happen. Example:

{ // Access data that is shared among multiple threads FScopeUnlock ScopeUnlock(SynchObject); ... // When ScopeUnlock goes out of scope, other threads can no longer access data }

Definition at line 93 of file ScopeLock.h.

Constructor & Destructor Documentation

FScopeUnlock() [1/3]

UE_NODISCARD_CTOR FScopeUnlock::FScopeUnlock ( FCriticalSection * InSynchObject )

inline

Constructor that performs a unlock on the synchronization object

Parameters

InSynchObject

The synchronization object to manage, can be null.

Definition at line 102 of file ScopeLock.h.

Here is the call graph for this function:

~FScopeUnlock()

FScopeUnlock::~FScopeUnlock ( )

inline

Destructor that performs a lock on the synchronization object.

Definition at line 112 of file ScopeLock.h.

Here is the call graph for this function:

FScopeUnlock() [2/3]

FScopeUnlock::FScopeUnlock ( )

private

Default constructor (hidden on purpose).

FScopeUnlock() [3/3]

FScopeUnlock::FScopeUnlock ( const FScopeUnlock & InScopeLock )

private

Copy constructor( hidden on purpose).

Member Function Documentation

operator=()

FScopeUnlock & FScopeUnlock::operator= ( FScopeUnlock & InScopeLock )

inlineprivate

Assignment operator (hidden on purpose).

Definition at line 128 of file ScopeLock.h.

Member Data Documentation

SynchObject

FCriticalSection* FScopeUnlock::SynchObject

private

Definition at line 136 of file ScopeLock.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/Misc/ScopeLock.h