physx::shdfnd::ThreadImpl Class Reference
#include <PsThread.h>
Public Types | |
| typedef size_t | Id |
| typedef void *(* | ExecuteFn )(void *) |
Public Member Functions | |
| ThreadImpl () | |
| ThreadImpl (ExecuteFn fn, void *arg) | |
| ~ThreadImpl () | |
| void | start (uint32_t stackSize, Runnable *r) |
| void | kill () |
| 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 uint32_t | getDefaultStackSize () |
| static Id | getId () |
| static ThreadPriority::Enum | getPriority (Id threadId) |
| static void | sleep (uint32_t ms) |
| static void | yield () |
| static uint32_t | getNbPhysicalCores () |
| static const uint32_t & | getSize () |
Member Typedef Documentation
| typedef void*(* physx::shdfnd::ThreadImpl::ExecuteFn)(void *) |
| typedef size_t physx::shdfnd::ThreadImpl::Id |
Constructor & Destructor Documentation
| physx::shdfnd::ThreadImpl::ThreadImpl | ( | ) |
Construct (but do not start) the thread object. The OS thread object will not be created until start() is called. Executes in the context of the spawning thread.
| physx::shdfnd::ThreadImpl::ThreadImpl | ( | ExecuteFn | fn, | |
| void * | arg | |||
| ) |
Construct and start the the thread, passing the given arg to the given fn. (pthread style)
| physx::shdfnd::ThreadImpl::~ThreadImpl | ( | ) |
Deallocate all resources associated with the thread. Should be called in the context of the spawning thread.
Member Function Documentation
| uint32_t physx::shdfnd::ThreadImpl::getDefaultStackSize | ( | ) | [static] |
| ThreadImpl::Id physx::shdfnd::ThreadImpl::getId | ( | ) | [static] |
| uint32_t physx::shdfnd::ThreadImpl::getNbPhysicalCores | ( | ) | [static] |
Return the number of physical cores (does not include hyper-threaded cores), returns 0 on failure
| ThreadPriority::Enum physx::shdfnd::ThreadImpl::getPriority | ( | Id | threadId | ) | [static] |
| const uint32_t & physx::shdfnd::ThreadImpl::getSize | ( | ) | [static] |
Size of this class.
| void physx::shdfnd::ThreadImpl::kill | ( | ) |
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::ThreadImpl::quit | ( | ) |
Cleanly shut down this thread. Called in the context of the spawned thread.
| bool physx::shdfnd::ThreadImpl::quitIsSignalled | ( | ) |
check whether the thread is signalled to quit. Called in the context of the spawned thread.
| uint32_t physx::shdfnd::ThreadImpl::setAffinityMask | ( | uint32_t | mask | ) |
Change the affinity mask for this thread. The mask is a platform specific value.
On Windows, Linux, PS4 and XboxOne platforms, each set mask bit represents the index of a logical processor that the OS may schedule thread execution on. Bits outside the range of valid logical processors may be ignored or cause the function to return an error.
On Apple platforms, this function has no effect.
If the thread has not yet been started then the mask is stored and applied when the thread is started.
If the thread has already been started then this method returns the previous affinity mask on success, otherwise it returns zero.
| void physx::shdfnd::ThreadImpl::setName | ( | const char * | name | ) |
set the thread's name
| void physx::shdfnd::ThreadImpl::setPriority | ( | ThreadPriority::Enum | prio | ) |
Set thread priority.
| void physx::shdfnd::ThreadImpl::signalQuit | ( | ) |
Stop the thread. Signals the spawned thread that it should stop, so the thread should check regularly
| void physx::shdfnd::ThreadImpl::sleep | ( | uint32_t | ms | ) | [static] |
Put the current thread to sleep for the given number of milliseconds
| void physx::shdfnd::ThreadImpl::start | ( | uint32_t | stackSize, | |
| Runnable * | r | |||
| ) |
Create the OS thread and start it running. Called in the context of the spawning thread. If an affinity mask has previously been set then it will be applied after the thread has been created.
| bool physx::shdfnd::ThreadImpl::waitForQuit | ( | ) |
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.
| void physx::shdfnd::ThreadImpl::yield | ( | ) | [static] |
Yield the current thread's slot on the CPU
The documentation for this class was generated from the following files:
- E:/p4/sw/physx/PxShared/1.0/trunk/src/foundation/include/PsThread.h
- E:/p4/sw/physx/PxShared/1.0/trunk/src/foundation/src/windows/PsWindowsThread.cpp
Generated on Tue Jul 28 14:22:01 2015 for NVIDIA(R) PsFoundation Reference by
1.5.8