#include <ScopedEvent.h>

Public Member Functions
CORE_API	FScopedEvent ()

CORE_API	~FScopedEvent ()

void	Trigger ()

CORE_API bool	IsReady ()

FEvent *	Get ()

Detailed Description

This class is allows a simple one-shot scoped event.

Usage: { FScopedEvent MyEvent; SendReferenceOrPointerToSomeOtherThread(&MyEvent); // Other thread calls MyEvent->Trigger(); // MyEvent destructor is here, we wait here. }

Constructor & Destructor Documentation

◆ FScopedEvent()

FScopedEvent::FScopedEvent ( )

Default constructor.

◆ ~FScopedEvent()

FScopedEvent::~FScopedEvent ( )

Destructor.

Member Function Documentation

◆ Get()

FEvent * FScopedEvent::Get ( )

inline

Retrieve the event, usually for passing around.

Returns: The event.

◆ IsReady()

bool FScopedEvent::IsReady ( )

Checks if the event has been triggered (used for special early out cases of scope event) if this returns true once it will return true forever

Returns: returns true if the scoped event has been triggered once

◆ Trigger()

void FScopedEvent::Trigger ( )