Navigation
API > API/Runtime > API/Runtime/Core
Interface for waitable events.
This interface has platform-specific implementations that are used to wait for another thread to signal that it is ready for the waiting thread to do some work. It can also be used for telling groups of threads to exit.
Consider using FEventRef as a safer and more convenient alternative.
| Name | FEvent |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/HAL/Event.h |
| Include Path | #include "HAL/Event.h" |
Syntax
class FEvent
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FEvent() |
Default constructor. | HAL/Event.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FEvent() |
Virtual destructor. | HAL/Event.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| EventUniqueId | TAtomic< uint32 > | Counter used to generate an unique id for the events. | HAL/Event.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AdvanceStats() |
Advances stats associated with this event. Used to monitor wait->trigger history. | HAL/Event.h | |
bool Create
(
bool bIsManualReset |
Creates the event. | HAL/Event.h | |
bool IsManualReset () |
Whether the signaled state of this event needs to be reset manually. | HAL/Event.h | |
void Reset () |
Resets the event to an untriggered (waitable) state. | HAL/Event.h | |
void Trigger () |
Triggers the event so any waiting threads are activated. | HAL/Event.h | |
bool Wait () |
Waits an infinite amount of time for the event to be triggered. | HAL/Event.h | |
bool Wait
(
uint32 WaitTime, |
Waits the specified amount of time for the event to be triggered. | HAL/Event.h | |
| Waits the specified amount of time for the event to be triggered. | HAL/Event.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ResetForStats() |
Resets start cycles to 0. | HAL/Event.h | |
void TriggerForStats() |
Send to the stats a special message which encodes a trigger for the event. | HAL/Event.h | |
void WaitForStats() |
Sends to the stats a special messages which encodes a wait for the event. | HAL/Event.h |