UE::HAL::Private::FGenericPlatformManualResetEvent Class Reference

#include <GenericPlatformManualResetEvent.h>

Public Member Functions
	FGenericPlatformManualResetEvent ()=default
	FGenericPlatformManualResetEvent (const FGenericPlatformManualResetEvent &)=delete
FGenericPlatformManualResetEvent &	operator= (const FGenericPlatformManualResetEvent &)=delete
void	Reset ()
bool	Poll ()
void	Wait ()
bool	WaitFor (FMonotonicTimeSpan WaitTime)
bool	WaitUntil (FMonotonicTimePoint WaitTime)
void	Notify ()

Detailed Description

A manual reset event that supports only one thread waiting and one thread notifying at a time.

Only one waiting thread may call Reset() or the Wait() functions. Only one notifying thread may call Notify() once until the event is reset.

Constructor & Destructor Documentation

FGenericPlatformManualResetEvent() [1/2]

UE::HAL::Private::FGenericPlatformManualResetEvent::FGenericPlatformManualResetEvent ( )

default

FGenericPlatformManualResetEvent() [2/2]

UE::HAL::Private::FGenericPlatformManualResetEvent::FGenericPlatformManualResetEvent ( const FGenericPlatformManualResetEvent &  )

delete

Member Function Documentation

Notify()

void UE::HAL::Private::FGenericPlatformManualResetEvent::Notify ( )

inline

Notifies the waiting thread.

Notify() may be called prior to one of the wait functions, and the eventual wait call will return immediately when that occurs.

operator=()

FGenericPlatformManualResetEvent & UE::HAL::Private::FGenericPlatformManualResetEvent::operator= ( const FGenericPlatformManualResetEvent &  )

delete

Poll()

bool UE::HAL::Private::FGenericPlatformManualResetEvent::Poll ( )

inline

Polls whether the event is in the notified state.

Returns

True if notified, otherwise false.

Reset()

void UE::HAL::Private::FGenericPlatformManualResetEvent::Reset ( )

inline

Resets the event to permit another Wait/Notify cycle.

Must only be called by the waiting thread, and only when there is no possibility of waking occurring concurrently with the reset.

Wait()

void UE::HAL::Private::FGenericPlatformManualResetEvent::Wait ( )

inline

Waits for Notify() to be called.

Notify() may be called prior to Wait(), and this will return immediately in that case.

WaitFor()

bool UE::HAL::Private::FGenericPlatformManualResetEvent::WaitFor ( FMonotonicTimeSpan  WaitTime )

inline

Waits for the wait time for Notify() to be called.

Notify() may be called prior to WaitFor(), and this will return immediately in that case.

Parameters

WaitTime

Relative time after which waiting is canceled and the thread wakes.

Returns

True if Notify() was called before the wait time elapsed, otherwise false.

WaitUntil()

bool UE::HAL::Private::FGenericPlatformManualResetEvent::WaitUntil ( FMonotonicTimePoint  WaitTime )

inline

Waits until the wait time for Notify() to be called.

Notify() may be called prior to WaitUntil(), and this will return immediately in that case.

Parameters

WaitTime

Absolute time after which waiting is canceled and the thread wakes.

Returns

True if Notify() was called before the wait time elapsed, otherwise false.

---

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

• Engine/Source/Runtime/Core/Private/GenericPlatform/GenericPlatformManualResetEvent.h