UE::HAL::Private::FMicrosoftManualResetEvent Class Reference

#include <MicrosoftPlatformManualResetEvent.h>

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

Detailed Description

See also

FGenericPlatformManualResetEvent

Constructor & Destructor Documentation

FMicrosoftManualResetEvent() [1/2]

UE::HAL::Private::FMicrosoftManualResetEvent::FMicrosoftManualResetEvent ( )

default

FMicrosoftManualResetEvent() [2/2]

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

delete

Member Function Documentation

Notify()

void UE::HAL::Private::FMicrosoftManualResetEvent::Notify

(

)

operator=()

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

delete

Poll()

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

inline

Reset()

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

inline

Wait()

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

inline

WaitFor()

bool UE::HAL::Private::FMicrosoftManualResetEvent::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.

NOTE: Windows will round the wait time to the nearest system tick and may coalesce timers for power efficiency. These details can cause a timeout to elapse slightly early.

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::FMicrosoftManualResetEvent::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.

NOTE: Windows will round the wait time to the nearest system tick and may coalesce timers for power efficiency. These details can cause a timeout to elapse slightly early.

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 files:

• Engine/Source/Runtime/Core/Private/Microsoft/MicrosoftPlatformManualResetEvent.h
• Engine/Source/Runtime/Core/Private/Microsoft/MicrosoftPlatformManualResetEvent.cpp