FWindowsPlatformProcess::FWindowsSemaphore Struct Reference

#include <WindowsPlatformProcess.h>

Inheritance diagram for FWindowsPlatformProcess::FWindowsSemaphore:

Collaboration diagram for FWindowsPlatformProcess::FWindowsSemaphore:

Public Member Functions
virtual void	Lock ()
virtual bool	TryLock (uint64 NanosecondsToWait)
virtual void	Unlock ()
Windows::HANDLE	GetSemaphore ()
	FWindowsSemaphore (const FString &InName, Windows::HANDLE InSemaphore)
	FWindowsSemaphore (const TCHAR *InName, Windows::HANDLE InSemaphore)
virtual	~FWindowsSemaphore ()
Public Member Functions inherited from FGenericPlatformProcess::FSemaphore
const TCHAR *	GetName () const
	FSemaphore (const FString &InName)
	FSemaphore (const TCHAR *InName)
virtual	~FSemaphore ()

Protected Attributes
Windows::HANDLE	Semaphore
Protected Attributes inherited from FGenericPlatformProcess::FSemaphore
TCHAR	Name [MaxSemaphoreName]

Additional Inherited Members
Protected Types inherited from FGenericPlatformProcess::FSemaphore
enum	Limits { MaxSemaphoreName = 128 }

Detailed Description

Windows representation of a interprocess semaphore

Definition at line 37 of file WindowsPlatformProcess.h.

Constructor & Destructor Documentation

FWindowsSemaphore() [1/2]

FWindowsPlatformProcess::FWindowsSemaphore::FWindowsSemaphore	(	const FString &	InName,
		Windows::HANDLE	InSemaphore )

Constructor

FWindowsSemaphore() [2/2]

FWindowsPlatformProcess::FWindowsSemaphore::FWindowsSemaphore	(	const TCHAR *	InName,
		Windows::HANDLE	InSemaphore )

Allocation free constructor

~FWindowsSemaphore()

virtual FWindowsPlatformProcess::FWindowsSemaphore::~FWindowsSemaphore ( )

virtual

Destructor

Member Function Documentation

GetSemaphore()

Windows::HANDLE FWindowsPlatformProcess::FWindowsSemaphore::GetSemaphore ( )

inline

Returns the OS handle

Definition at line 44 of file WindowsPlatformProcess.h.

Lock()

virtual void FWindowsPlatformProcess::FWindowsSemaphore::Lock ( )

virtual

Acquires an exclusive access (also known as Wait())

Implements FGenericPlatformProcess::FSemaphore.

TryLock()

virtual bool FWindowsPlatformProcess::FWindowsSemaphore::TryLock ( uint64 NanosecondsToWait )

virtual

Tries to acquire and exclusive access for a specified amount of nanoseconds (also known as TryWait()).

Parameters

Nanoseconds

(10^-9 seconds) to wait for,

Returns

false if was not able to lock within given time

Implements FGenericPlatformProcess::FSemaphore.

Unlock()

virtual void FWindowsPlatformProcess::FWindowsSemaphore::Unlock ( )

virtual

Relinquishes an exclusive access (also known as Release())

Implements FGenericPlatformProcess::FSemaphore.

Member Data Documentation

Semaphore

Windows::HANDLE FWindowsPlatformProcess::FWindowsSemaphore::Semaphore

protected

OS handle

Definition at line 58 of file WindowsPlatformProcess.h.

---

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

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