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

NVIDIA PhysX

previous page next page

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

#include <PsThread.h>

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

< Alloc >_map" border="0" alt="">
< Alloc >_map"> Alloc physx::shdfnd::UserAllocated physx::shdfnd::Runnable

List of all members.

Public Types

typedef ThreadImpl::Id Id

Public Member Functions

 ThreadT (const Alloc &alloc=Alloc())
 ThreadT (ThreadImpl::ExecuteFn fn, void *arg, const Alloc &alloc=Alloc())
virtual ~ThreadT ()
void start (uint32_t stackSize=ThreadImpl::getDefaultStackSize())
void kill ()
virtual void execute (void)
void signalQuit ()
bool waitForQuit ()
bool quitIsSignalled ()
void quit ()
uint32_t setAffinityMask (uint32_t mask)
void setPriority (ThreadPriority::Enum prio)
void setName (const char *name)

Static Public Member Functions

static ThreadPriority::Enum getPriority (ThreadImpl::Id threadId)
static void sleep (uint32_t ms)
static void yield ()
static uint32_t getDefaultStackSize ()
static ThreadImpl::Id getId ()
static uint32_t getNbPhysicalCores ()

Detailed Description

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
class physx::shdfnd::ThreadT< Alloc >

Thread abstraction API

Member Typedef Documentation

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
typedef ThreadImpl::Id physx::shdfnd::ThreadT< Alloc >::Id

Constructor & Destructor Documentation

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

Construct (but do not start) the thread object. Executes in the context of the spawning thread

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
physx::shdfnd::ThreadT< Alloc >::ThreadT ( ThreadImpl::ExecuteFn  fn,
void *  arg,
const Alloc &  alloc = Alloc() 
) [inline]

Construct and start the the thread, passing the given arg to the given fn. (pthread style)

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
virtual physx::shdfnd::ThreadT< Alloc >::~ThreadT (  )  [inline, virtual]

Deallocate all resources associated with the thread. Should be called in the context of the spawning thread.

Member Function Documentation

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
virtual void physx::shdfnd::ThreadT< Alloc >::execute ( void   )  [inline, virtual]

The virtual execute() method is the user defined function that will run in the new thread. Called in the context of the spawned thread.

Reimplemented from physx::shdfnd::Runnable.

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
static uint32_t physx::shdfnd::ThreadT< Alloc >::getDefaultStackSize (  )  [inline, static]

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
static ThreadImpl::Id physx::shdfnd::ThreadT< Alloc >::getId (  )  [inline, static]

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
static uint32_t physx::shdfnd::ThreadT< Alloc >::getNbPhysicalCores (  )  [inline, static]

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
static ThreadPriority::Enum physx::shdfnd::ThreadT< Alloc >::getPriority ( ThreadImpl::Id  threadId  )  [inline, static]

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
void physx::shdfnd::ThreadT< Alloc >::kill (  )  [inline]

Violently kill the current thread. Blunt instrument, not recommended since it can leave all kinds of things unreleased (stack, memory, mutexes...) Should be called in the context of the spawning thread.

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
void physx::shdfnd::ThreadT< Alloc >::quit (  )  [inline]

Cleanly shut down this thread. Called in the context of the spawned thread.

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
bool physx::shdfnd::ThreadT< Alloc >::quitIsSignalled (  )  [inline]

check whether the thread is signalled to quit. Called in the context of the spawned thread.

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
uint32_t physx::shdfnd::ThreadT< Alloc >::setAffinityMask ( uint32_t  mask  )  [inline]

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
void physx::shdfnd::ThreadT< Alloc >::setName ( const char *  name  )  [inline]

set the thread's name

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
void physx::shdfnd::ThreadT< Alloc >::setPriority ( ThreadPriority::Enum  prio  )  [inline]

Set thread priority.

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
void physx::shdfnd::ThreadT< Alloc >::signalQuit (  )  [inline]

stop the thread. Signals the spawned thread that it should stop, so the thread should check regularly

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
static void physx::shdfnd::ThreadT< Alloc >::sleep ( uint32_t  ms  )  [inline, static]

Put the current thread to sleep for the given number of milliseconds

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
void physx::shdfnd::ThreadT< Alloc >::start ( uint32_t  stackSize = ThreadImpl::getDefaultStackSize()  )  [inline]

start the thread running. Called in the context of the spawning thread.

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
bool physx::shdfnd::ThreadT< Alloc >::waitForQuit (  )  [inline]

Wait for a thread to stop. Should be called in the context of the spawning thread. Returns false if the thread has not been started.

template<typename Alloc = ReflectionAllocator<ThreadImpl>>
static void physx::shdfnd::ThreadT< Alloc >::yield (  )  [inline, static]

Yield the current thread's slot on the CPU

The documentation for this class was generated from the following file:
  • E:/p4/sw/physx/PxShared/1.0/trunk/src/foundation/include/PsThread.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