Public Member Functions

openalpp::Event Class Reference

List of all members.

Public Member Functions

 Event ()
 Default constructor.
virtual ~Event ()
 Destructor.
void reset (void)
void signal (void)
bool wait (unsigned long timeout=INFINITE)

Constructor & Destructor Documentation

openalpp::Event::Event (  ) 

Default constructor.

virtual openalpp::Event::~Event (  )  [virtual]

Destructor.


Member Function Documentation

void openalpp::Event::reset ( void   ) 

When an Event has been signaled, it has to be reset before it can respond to a new signal.

void openalpp::Event::signal ( void   ) 

Signal the event for the waiting thread.

bool openalpp::Event::wait ( unsigned long  timeout = INFINITE  ) 

Wait either for the event to be signaled by another thread or for the specified timeout duration.

Returns:
true if it has been signaled, false if it didnt get a signal before timeout.
Parameters:
timer timeout in milliseconds to wait for a signal.

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