Name 

Description 

 

Context 

A ThreadPool context defines a logical context in which WorkItems are being executed. Their primary use is for biasing priorities of WorkItems.
Contexts are arranged in a tree hierarchy. Each parent node's priority bias scales all the priority biases underneath it.
Note that instances of this class are meant to be instantiated globally only. 

 

WorkItem 

An action to execute on a worker thread from the pool.
Work items are concurrently reference-counted and will be automatically released once the last reference disappears. 

 

Name 

Description 

 

mName 

Name of this pool. Mainly for debugging. Used to name worker threads. 

 

mNumThreads 

Number of worker threads spawned by the pool. 

 

mNumThreadsAwake 

Number of worker threads in non-sleeping state. 

 

mNumThreadsReady 

Number of worker threads guaranteed to be non-blocking. 

 

mSemaphore 

Semaphore used to wake up threads, if necessary. 

 

mThreads 

List of worker threads. 

 

mWorkItemQueue 

Threaded priority queue for concurrent access by worker threads. 

 

smForceAllMainThread 

Force all work items to execute on main thread; turns this into a single-threaded system. Primarily useful to find whether malfunctions are caused by parallel execution or not. 

 

smMainThreadQueue 

Work queue for main thread; can be used to ping back work items to main thread that need processing that can only happen on main thread. 

 

smMainThreadTimeMS 

 

Name 

Description 

struct WorkerThread 

mSemaphore, mNumThreadsAwake, mThreads 

 

Name 

Description 

 

createSingleton 

Create the singleton instance. @note Asserts when the singleton instance has already been constructed. 

 

deleteSingleton 

Destroy the singleton instance. @note Asserts when no singleton has been constructed. 

 

flushWorkItems 

For the global pool, it is very important to only ever call this function on the main thread and to let work items only ever come from the main thread. Otherwise this function has the potential of dead-locking as new work items may constantly be fed to the queue without it ever getting empty. @param timeOut Soft limit on the number of milliseconds to wait for the queue to flush out. -1 = infinite.
 

 

getForceAllMainThread 

 

 

getMainThreadThresholdTimeMS 

 

 

getQueueTimeBasedPriorityBoost 

Return the priority increment applied to work items on each passing of the update interval. 

 

getQueueUpdateInterval 

Return the interval in which item priorities are updated on the queue. @return update interval in milliseconds. 

 

getSingletonName 

For ManagedSingleton. 

 

GLOBAL 

Return the global thread pool singleton. 

 

instance 

Return the singleton instance. @note Asserts when called before createSingleton(). 

 

instanceOrNull 

Return the singleton instance or NULL if it has been deleted or not yet constructed. 

 

processMainThreadWorkItems 

Process work items waiting on the main thread's work queue.
There is a soft limit imposed on the time this method is allowed to run so as to balance frame-to-frame load. However, work items, once their processing is initiated, will not be suspended and will run for as long as they take to complete, so make sure individual items perform as little work as necessary.
@see ThreadPool::getMainThreadThesholdTimeMS
 

 

queueWorkItem 

 

 

queueWorkItemOnMainThread 

Add a work item to the main thread's work queue.
The main thread's work queue will be processed each frame using a set timeout to limit the work being done. Nonetheless, work items will not be suspended in-midst of processing, so make sure that whatever work you issue to the main thread is light work or you may see short hangs in gameplay.
To reiterate this: any code executed through this interface directly adds to frame processing time on the main thread.
This method *may* (and is meant to) be called from threads other than the main thread.
 

 

setQueueTimeBasedPriorityBoost 

Set the priority increment applied to work items on each update interval. @param value Priority increment. Set to zero to deactivate. 

 

setQueueUpdateInterval 

Set the update interval of the work item queue to the given value. @param milliSeconds Time between updates in milliseconds. 

 

SFXThreadPool 

Create a ThreadPool called "SFX" with two threads. 

 

shutdown 

Manually shutdown threads outside of static destructors.
 

Name 

Description 

Parent 

This is nested type SFXInternal::SFXThreadPool::Parent. 

QueueType 

This is nested type ThreadPool::QueueType. 

WorkItemPtr 

This is nested type ThreadPool::WorkItemPtr.