Containment Domains C++ API  0.1
Containment Domains C++ API v0.1
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Groups Pages
Functions
CD Event Functions for Non-Blocking Calls

Functions

CDErrT cd::CDEvent::Wait (void)
 Blocking call waiting on the event to complete. More...
 
bool cd::CDEvent::Test (void)
 Non-blocking call to test whether the event completed. More...
 

Detailed Description

Function Documentation

bool cd::CDEvent::Test ( void  )

Non-blocking call to test whether the event completed.

Returns
true if complete and false is any chained events not yet done.
CDErrT cd::CDEvent::Wait ( void  )

Blocking call waiting on the event to complete.

Once CDEvent::Wait() returns, the event is empty (uninitialized), as if it has been explicitly CDEvent::Reset().

Returns
kOK on success and kError if the event timed out