physx::shdfnd::ThreadT< Alloc > Class Template Reference
#include <PsThread.h>
< Alloc >_map" border="0" alt="">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
| typedef ThreadImpl::Id physx::shdfnd::ThreadT< Alloc >::Id |
Constructor & Destructor Documentation
| 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
| 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)
| 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
| 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.
| static uint32_t physx::shdfnd::ThreadT< Alloc >::getDefaultStackSize | ( | ) | [inline, static] |
| static ThreadImpl::Id physx::shdfnd::ThreadT< Alloc >::getId | ( | ) | [inline, static] |
| static uint32_t physx::shdfnd::ThreadT< Alloc >::getNbPhysicalCores | ( | ) | [inline, static] |
| static ThreadPriority::Enum physx::shdfnd::ThreadT< Alloc >::getPriority | ( | ThreadImpl::Id | threadId | ) | [inline, static] |
| 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.
| void physx::shdfnd::ThreadT< Alloc >::quit | ( | ) | [inline] |
Cleanly shut down this thread. Called in the context of the spawned thread.
| bool physx::shdfnd::ThreadT< Alloc >::quitIsSignalled | ( | ) | [inline] |
check whether the thread is signalled to quit. Called in the context of the spawned thread.
| uint32_t physx::shdfnd::ThreadT< Alloc >::setAffinityMask | ( | uint32_t | mask | ) | [inline] |
| void physx::shdfnd::ThreadT< Alloc >::setName | ( | const char * | name | ) | [inline] |
set the thread's name
| void physx::shdfnd::ThreadT< Alloc >::setPriority | ( | ThreadPriority::Enum | prio | ) | [inline] |
Set thread priority.
| void physx::shdfnd::ThreadT< Alloc >::signalQuit | ( | ) | [inline] |
stop the thread. Signals the spawned thread that it should stop, so the thread should check regularly
| static void physx::shdfnd::ThreadT< Alloc >::sleep | ( | uint32_t | ms | ) | [inline, static] |
Put the current thread to sleep for the given number of milliseconds
| void physx::shdfnd::ThreadT< Alloc >::start | ( | uint32_t | stackSize = ThreadImpl::getDefaultStackSize() |
) | [inline] |
start the thread running. Called in the context of the spawning thread.
| 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.
| 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
1.5.8