documentation.help

NVIDIA(R) PsFoundation Reference: physx::shdfnd::SyncT< Alloc > Class Template Reference

From NVIDIA PhysX

previous page next page

physx::shdfnd::SyncT< Alloc > Class Template Reference

#include <PsSync.h>

Inheritance diagram for physx::shdfnd::SyncT< Alloc >:

< Alloc >_map" border="0" alt="">
< Alloc >_map"> Alloc

List of all members.

Public Member Functions

 SyncT (const Alloc &alloc=Alloc())
 ~SyncT ()
bool wait (uint32_t milliseconds=SyncImpl::waitForever)
void set ()
void reset ()

Static Public Attributes

static const uint32_t waitForever = SyncImpl::waitForever

Detailed Description

template<typename Alloc = ReflectionAllocator<SyncImpl>>
class physx::shdfnd::SyncT< Alloc >

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

template<typename Alloc = ReflectionAllocator<SyncImpl>>
physx::shdfnd::SyncT< Alloc >::SyncT ( const Alloc &  alloc = Alloc()  )  [inline]

template<typename Alloc = ReflectionAllocator<SyncImpl>>
physx::shdfnd::SyncT< Alloc >::~SyncT (  )  [inline]

Member Function Documentation

template<typename Alloc = ReflectionAllocator<SyncImpl>>
void physx::shdfnd::SyncT< Alloc >::reset (  )  [inline]

Reset the synchronization object

template<typename Alloc = ReflectionAllocator<SyncImpl>>
void physx::shdfnd::SyncT< Alloc >::set (  )  [inline]

Signal the synchronization object, waking all threads waiting on it

template<typename Alloc = ReflectionAllocator<SyncImpl>>
bool physx::shdfnd::SyncT< Alloc >::wait ( uint32_t  milliseconds = SyncImpl::waitForever  )  [inline]

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

template<typename Alloc = ReflectionAllocator<SyncImpl>>
const uint32_t physx::shdfnd::SyncT< Alloc >::waitForever = SyncImpl::waitForever [static]

The documentation for this class was generated from the following file:
  • E:/p4/sw/physx/PxShared/1.0/trunk/src/foundation/include/PsSync.h

Generated on Tue Jul 28 14:22:01 2015 for NVIDIA(R) PsFoundation Reference by  doxygen 1.5.8
previous page start next page