Platform-independent definition of event objects. More...

#include <Event.h>

Inheritance diagram for OpenZWave::Internal::Platform::Event:

Collaboration diagram for OpenZWave::Internal::Platform::Event:

Public Member Functions
	Event ()
void	Set ()
void	Reset ()
Public Member Functions inherited from OpenZWave::Internal::Platform::Wait
void	AddWatcher (pfnWaitNotification_t _callback, void *_context)
void	RemoveWatcher (pfnWaitNotification_t _callback, void *_context)
Public Member Functions inherited from OpenZWave::Internal::Platform::Ref
	Ref ()
void	AddRef ()
int32	Release ()

Protected Member Functions
virtual bool	IsSignalled ()
bool	Wait (int32 _timeout)
	~Event ()
Protected Member Functions inherited from OpenZWave::Internal::Platform::Wait
	Wait ()
virtual	~Wait ()
void	Notify ()
Protected Member Functions inherited from OpenZWave::Internal::Platform::Ref
virtual	~Ref ()

Friends
class	SerialControllerImpl
class	Wait

Additional Inherited Members
Public Types inherited from OpenZWave::Internal::Platform::Wait
enum	{ Timeout_Immediate = 0 , Timeout_Infinite = -1 }
typedef void(*	pfnWaitNotification_t) (void *_context)
Static Public Member Functions inherited from OpenZWave::Internal::Platform::Wait
static int32	Single (Wait *_object, int32 _timeout=-1)
static int32	Multiple (Wait **_objects, uint32 _numObjects, int32 _timeout=-1)

Detailed Description

Platform-independent definition of event objects.

Constructor & Destructor Documentation

◆ Event()

OpenZWave::Internal::Platform::Event::Event ( )

Constructor. Creates a cross-platform event object equivalent to the Windows manual-reset event

◆ ~Event()

OpenZWave::Internal::Platform::Event::~Event ( )

protected

Destructor. Destroys the event object.

Member Function Documentation

◆ IsSignalled()

bool OpenZWave::Internal::Platform::Event::IsSignalled ( )

protectedvirtual

Used by the Wait class to test whether the event is set.

Implements OpenZWave::Internal::Platform::Wait.

◆ Reset()

void OpenZWave::Internal::Platform::Event::Reset ( )

Set the event to not signalled.

See also: Set, Wait

◆ Set()

void OpenZWave::Internal::Platform::Event::Set ( )

Set the event to signalled.

See also: Reset, Wait

◆ Wait()

bool OpenZWave::Internal::Platform::Event::Wait ( int32 _timeout )

protected

Used by the Wait::Multiple method. returns true if the event signalled, false if it timed out

◆ SerialControllerImpl

friend class SerialControllerImpl

friend

◆ Wait

friend class Wait

friend

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

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members