Win32::Win32Event Class Reference

#include <win32event.h>

Detailed Description

Win32 implementation of an event synchronization object.

Copyright

(C) 2006 Radon Labs GmbH (C) 2013-2020 Individual contributors, see AUTHORS file

Public Member Functions
	Win32Event (bool manualReset=false)
	constructor
	Win32Event (Win32Event &&rhs)
	move constructor
	~Win32Event ()
	destructor
void	Signal ()
	signal the event
void	Reset ()
	reset the event (only if manual reset)
void	Wait () const
	wait for the event to become signalled
bool	WaitTimeout (int ms) const
	wait for the event with timeout in millisecs
bool	Peek () const
	check if event is signalled
bool	IsManual () const
	Returns true if event is manually reset.

Private Attributes
bool	manual
HANDLE	event

Constructor & Destructor Documentation

Win32Event() [1/2]

Win32::Win32Event::Win32Event ( bool manualReset = false )

inline

constructor

Win32Event() [2/2]

Win32::Win32Event::Win32Event ( Win32Event && rhs )

inline

move constructor

~Win32Event()

Win32::Win32Event::~Win32Event ( )

inline

destructor

Member Function Documentation

IsManual()

bool Win32::Win32Event::IsManual ( ) const

inline

Returns true if event is manually reset.

Peek()

bool Win32::Win32Event::Peek ( ) const

inline

check if event is signalled

This checks if the event is signalled and returnes immediately.

Reset()

void Win32::Win32Event::Reset ( )

inline

reset the event (only if manual reset)

Signal()

void Win32::Win32Event::Signal ( )

inline

signal the event

Wait()

void Win32::Win32Event::Wait ( ) const

inline

wait for the event to become signalled

WaitTimeout()

bool Win32::Win32Event::WaitTimeout ( int timeoutInMilliSec ) const

inline

wait for the event with timeout in millisecs

Waits for the event to become signaled with a specified timeout in milli seconds.

If the method times out it will return false, if the event becomes signalled within the timeout it will return true.

Member Data Documentation

event

HANDLE Win32::Win32Event::event

private

manual

bool Win32::Win32Event::manual

private

---

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

• /github/workspace/code/foundation/threading/win32/win32event.h