A set of threads that will run a list of jobs. More...

#include "juce_ThreadPool.h"

Public Member Functions
ThreadPoolOptions	withThreadName (String newThreadName) const
	The name to give each thread in the pool.

ThreadPoolOptions	withNumberOfThreads (int newNumberOfThreads) const
	The number of threads to run.

ThreadPoolOptions	withThreadStackSizeBytes (size_t newThreadStackSizeBytes) const
	The size of the stack of each thread in the pool.

ThreadPoolOptions	withDesiredThreadPriority (Thread::Priority newDesiredThreadPriority) const
	The desired priority of each thread in the pool.

Public Attributes
String	threadName

int	numberOfThreads

size_t	threadStackSizeBytes

Thread::Priority	desiredThreadPriority

Detailed Description

A set of threads that will run a list of jobs.

When a ThreadPoolJob object is added to the ThreadPool's list, its runJob() method will be called by the next pooled thread that becomes free.

See also: ThreadPoolJob, Thread

@tags{Core}

Definition at line 154 of file juce_ThreadPool.h.

Member Function Documentation

◆ withDesiredThreadPriority()

ThreadPoolOptions juce::ThreadPoolOptions::withDesiredThreadPriority ( Thread::Priority newDesiredThreadPriority ) const

The desired priority of each thread in the pool.

Definition at line 177 of file juce_ThreadPool.h.

◆ withNumberOfThreads()

ThreadPoolOptions juce::ThreadPoolOptions::withNumberOfThreads ( int newNumberOfThreads ) const

The number of threads to run.

These will be started when a pool is created, and run until the pool is destroyed.

Definition at line 165 of file juce_ThreadPool.h.

◆ withThreadName()

ThreadPoolOptions juce::ThreadPoolOptions::withThreadName ( String newThreadName ) const

The name to give each thread in the pool.

Definition at line 157 of file juce_ThreadPool.h.

◆ withThreadStackSizeBytes()

ThreadPoolOptions juce::ThreadPoolOptions::withThreadStackSizeBytes ( size_t newThreadStackSizeBytes ) const

The size of the stack of each thread in the pool.

Definition at line 171 of file juce_ThreadPool.h.

Member Data Documentation

◆ desiredThreadPriority

Thread::Priority juce::ThreadPoolOptions::desiredThreadPriority

Definition at line 185 of file juce_ThreadPool.h.

◆ numberOfThreads

int juce::ThreadPoolOptions::numberOfThreads

Definition at line 183 of file juce_ThreadPool.h.

◆ threadName

String juce::ThreadPoolOptions::threadName

Definition at line 182 of file juce_ThreadPool.h.

◆ threadStackSizeBytes

size_t juce::ThreadPoolOptions::threadStackSizeBytes

Definition at line 184 of file juce_ThreadPool.h.

The documentation for this struct was generated from the following file:

juce_core/threads/juce_ThreadPool.h

Public Member Functions

Public Attributes