UE::FManualResetEvent Class Reference

#include <ManualResetEvent.h>

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

Detailed Description

A type of event that remains notified until manually reset.

Constructor & Destructor Documentation

FManualResetEvent() [1/2]

constexpr UE::FManualResetEvent::FManualResetEvent ( )

constexprdefault

FManualResetEvent() [2/2]

UE::FManualResetEvent::FManualResetEvent ( const FManualResetEvent &  )

delete

Member Function Documentation

IsNotified()

bool UE::FManualResetEvent::IsNotified ( ) const

inline

Returns true if the event is notified, otherwise false.

Notify()

void UE::FManualResetEvent::Notify ( )

inline

Notifies all waiting threads and leaves the event notified until the next call to Reset().

operator=()

FManualResetEvent & UE::FManualResetEvent::operator= ( const FManualResetEvent &  )

delete

Reset()

void UE::FManualResetEvent::Reset ( )

inline

Resets the event to a non-notified state.

Wait()

void UE::FManualResetEvent::Wait ( )

inline

Wait until the event is notified.

WaitFor()

bool UE::FManualResetEvent::WaitFor ( FMonotonicTimeSpan  WaitTime )

inline

Wait until the event is notified.

Parameters

WaitTime

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

Returns

True if the event was notified before the wait time elapsed, otherwise false.

WaitUntil()

bool UE::FManualResetEvent::WaitUntil ( FMonotonicTimePoint  WaitTime )

inline

Wait until the event is notified.

Parameters

WaitTime

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

Returns

True if the event was notified before the wait time elapsed, otherwise false.

---

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

• Engine/Source/Runtime/Core/Public/Async/ManualResetEvent.h