A set of wait objects. More...
#include <pylon/WaitObjects.h>
Public Member Functions | |
WaitObjects () | |
Creates an empty wait object set. | |
~WaitObjects () | |
destructor | |
WaitObjects (const WaitObjects &) | |
copy constructor | |
WaitObjects & | operator= (const WaitObjects &) |
assignment operator | |
unsigned | Add (const WaitObject &o) |
Add an object to wait on and return the index of the added object. More... | |
void | RemoveAll (void) |
Removes all added wait objects. More... | |
bool | WaitForAll (unsigned timeout) const |
Wait for all objects to get signaled. More... | |
bool | WaitForAny (unsigned timeout, unsigned *pIndex=NULL) const |
Wait for any one object to get signaled. More... | |
EWaitExResult | WaitForAllEx (unsigned timeout, bool bAlertable) const |
Wait for all objects to get signaled. More... | |
EWaitExResult | WaitForAnyEx (unsigned timeout, bool bAlertable, unsigned *pIndex=NULL) const |
Wait for any one object to get signaled. More... | |
A set of wait objects.
unsigned Pylon::WaitObjects::Add | ( | const WaitObject & | o | ) |
Add an object to wait on and return the index of the added object.
Calling Add from another thread during wait operations will cause undefined behaviour.
void Pylon::WaitObjects::RemoveAll | ( | void | ) |
Removes all added wait objects.
Calling RemoveAll from another thread during wait operations will cause undefined behaviour.
bool Pylon::WaitObjects::WaitForAll | ( | unsigned | timeout | ) | const |
Wait for all objects to get signaled.
timeout | maximum wait period in milliseconds |
EWaitExResult Pylon::WaitObjects::WaitForAllEx | ( | unsigned | timeout, |
bool | bAlertable | ||
) | const |
Wait for all objects to get signaled.
bAlertable | If true, the wait operation can be interrupted (Windows: APC; UNIX: signal) |
timeout | maximum wait period in milliseconds |
bool Pylon::WaitObjects::WaitForAny | ( | unsigned | timeout, |
unsigned * | pIndex = NULL |
||
) | const |
Wait for any one object to get signaled.
timeout | maximum wait period in milliseconds |
*pIndex | (optional) pointer to buffer taking the index of the signaled object |
EWaitExResult Pylon::WaitObjects::WaitForAnyEx | ( | unsigned | timeout, |
bool | bAlertable, | ||
unsigned * | pIndex = NULL |
||
) | const |
Wait for any one object to get signaled.
timeout | maximum wait period in milliseconds |
bAlertable | If true, the wait operation can be interrupted (Windows: APC; UNIX: signal) |
*pIndex | (optional) pointer to buffer taking the index of the signaled object |