commore  1.0.6-SNAPSHOT
 All Classes Namespaces Functions Variables Typedefs Enumerations Pages
commore::Event Class Reference

#include <Thread.h>

Public Member Functions

 Event (bool create=true)
 
 Event (const AChar *name)
 
bool create (const AChar *name=0)
 
bool is_valid ()
 
bool wait (const TimePeriod &timeout)
 
bool wait ()
 
void signal ()
 
void reset ()
 
void * get () const
 

Detailed Description

A simple Event commore implementation

Constructor & Destructor Documentation

commore::Event::Event ( bool  create = true)
Parameters
createif true create the event system objet
commore::Event::Event ( const AChar *  name)
Parameters
namecreate a named event
Remarks
no linux implemented

Member Function Documentation

bool commore::Event::create ( const AChar *  name = 0)

Create a named event

Parameters
nameof system event
Remarks
no linux implemented
Returns
true if succeed
void* commore::Event::get ( ) const
inline
Returns
internal system event handle
Remarks
should not be use
bool commore::Event::is_valid ( )
Returns
true if system event exists
void commore::Event::reset ( )

Reset signaled event

void commore::Event::signal ( )

Signal the system event

bool commore::Event::wait ( const TimePeriod timeout)

Wait until the event is signaled.

Returns
true if event is signaled.
Parameters
timeoutMaximum waiting time
bool commore::Event::wait ( )

Wait until the event is signaled.

Returns
true if event is signaled.

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