FEventWin Class Reference

#include <WindowsEvent.h>

Inheritance diagram for FEventWin:

Public Member Functions
	FEventWin ()
virtual	~FEventWin ()
virtual bool	Create (bool bIsManualReset=false) override
virtual bool	IsManualReset () override
virtual void	Trigger () override
virtual void	Reset () override
virtual bool	Wait (uint32 WaitTime, const bool bIgnoreThreadIdleStats=false) override
Public Member Functions inherited from FEvent
bool	Wait ()
bool	Wait (const FTimespan &WaitTime, const bool bIgnoreThreadIdleStats=false)
	FEvent ()
virtual	~FEvent ()
CORE_API void	AdvanceStats ()

Additional Inherited Members
Protected Member Functions inherited from FEvent
CORE_API void	WaitForStats ()
CORE_API void	TriggerForStats ()
CORE_API void	ResetForStats ()
Protected Attributes inherited from FEvent
uint32	EventId
TAtomic< uint32 >	EventStartCycles
Static Protected Attributes inherited from FEvent
static CORE_API TAtomic< uint32 >	EventUniqueId

Detailed Description

Implements the Windows version of the FEvent interface.

Constructor & Destructor Documentation

FEventWin()

FEventWin::FEventWin ( )

inline

Default constructor.

~FEventWin()

virtual FEventWin::~FEventWin ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

Create()

virtual bool FEventWin::Create ( bool  bIsManualReset = false )

inlineoverridevirtual

Creates the event.

Manually reset events stay triggered until reset. Named events share the same underlying event.

Parameters

bIsManualReset

Whether the event requires manual reseting or not.

Returns

true if the event was created, false otherwise.

Implements FEvent.

IsManualReset()

virtual bool FEventWin::IsManualReset ( )

inlineoverridevirtual

Whether the signaled state of this event needs to be reset manually.

Returns

true if the state requires manual resetting, false otherwise.

See also

Reset

Implements FEvent.

Reset()

void FEventWin::Reset ( )

overridevirtual

Resets the event to an untriggered (waitable) state.

See also

IsManualReset, Trigger

Implements FEvent.

Trigger()

void FEventWin::Trigger ( )

overridevirtual

Triggers the event so any waiting threads are activated.

See also

IsManualReset, Reset

Implements FEvent.

Wait()

bool FEventWin::Wait ( uint32  WaitTime, const bool  bIgnoreThreadIdleStats = false  )

overridevirtual

Waits the specified amount of time for the event to be triggered.

A wait time of MAX_uint32 is treated as infinite wait.

Parameters

WaitTime	The time to wait (in milliseconds).
bIgnoreThreadIdleStats	If true, ignores ThreadIdleStats

Returns

true if the event was triggered, false if the wait timed out.

Implements FEvent.

---

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

• Engine/Source/Runtime/Core/Private/Windows/WindowsEvent.h
• Engine/Source/Runtime/Core/Private/Windows/WindowsPlatformProcess.cpp