physx::shdfnd::SyncImpl Class Reference
#include <PsSync.h>
Public Member Functions | |
SyncImpl () | |
~SyncImpl () | |
bool | wait (uint32_t milliseconds=waitForever) |
void | set () |
void | reset () |
Static Public Member Functions | |
static const uint32_t & | getSize () |
Static Public Attributes | |
static const uint32_t | waitForever = 0xffffffff |
Detailed Description
Implementation notes:- Calling set() on an already signaled Sync does not change its state.
- Calling reset() on an already reset Sync does not change its state.
- Calling set() on a reset Sync wakes all waiting threads (potential for thread contention).
- Calling wait() on an already signaled Sync will return true immediately.
- NOTE: be careful when pulsing an event with set() followed by reset(), because a thread that is not waiting on the event will miss the signal.
Constructor & Destructor Documentation
physx::shdfnd::SyncImpl::SyncImpl | ( | ) |
physx::shdfnd::SyncImpl::~SyncImpl | ( | ) |
Member Function Documentation
const uint32_t & physx::shdfnd::SyncImpl::getSize | ( | ) | [static] |
Size of this class.
void physx::shdfnd::SyncImpl::reset | ( | ) |
Reset the synchronization object
void physx::shdfnd::SyncImpl::set | ( | ) |
Signal the synchronization object, waking all threads waiting on it
bool physx::shdfnd::SyncImpl::wait | ( | uint32_t | milliseconds = waitForever |
) |
Wait on the object for at most the given number of ms. Returns true if the object is signaled. Sync::waitForever will block forever or until the object is signaled.
Member Data Documentation
const uint32_t physx::shdfnd::SyncImpl::waitForever = 0xffffffff [static] |
The documentation for this class was generated from the following files:
- E:/p4/sw/physx/PxShared/1.0/trunk/src/foundation/include/PsSync.h
- E:/p4/sw/physx/PxShared/1.0/trunk/src/foundation/src/windows/PsWindowsSync.cpp
Generated on Tue Jul 28 14:22:00 2015 for NVIDIA(R) PsFoundation Reference by 1.5.8