kanzi::detail::Event Class Reference

Event object. More...

#include <kanzi/core.ui/platform/task_dispatcher/win32/event.hpp>

Public Member Functions

 Event ()
 Constructor. More...
 
 ~Event ()
 Destructor. More...
 
void signal ()
 Sets event to signaled state. More...
 
void clear ()
 Sets event to non-signaled state. More...
 
NativeEventHandle getNativeEventHandle () const
 Returns native event handle for this event. More...
 

Detailed Description

Event object.

Represents an event in either signaled or non-signaled state. The signaled state allows a thread waiting on the native event handle to proceed. When used from different threads, signaling changes need to be externally synchronized.

Constructor & Destructor Documentation

kanzi::detail::Event::Event ( )
explicit

Constructor.

Creates an event in non-signaled state.

kanzi::detail::Event::~Event ( )

Destructor.

Member Function Documentation

void kanzi::detail::Event::signal ( )

Sets event to signaled state.

void kanzi::detail::Event::clear ( )

Sets event to non-signaled state.

NativeEventHandle kanzi::detail::Event::getNativeEventHandle ( ) const

Returns native event handle for this event.


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