The Nebula Device 3: Win32::Win32Event Class Reference

The Nebula Device 3

Win32::Win32Event Class Reference

#include <win32event.h>

Inheritance diagram for Win32::Win32Event:

Threading::Event


Detailed Description

Win32 implmentation of an event synchronization object.

(C) 2006 Radon Labs GmbH

Public Member Functions

 Win32Event ()
 constructor
 ~Win32Event ()
 destructor
void Signal ()
 signal the event
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

Member Function Documentation

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.

bool Win32::Win32Event::Peek (  )  const [inline]

check if event is signalled

This checks if the event is signalled and returnes immediately.