|
JUCE
|
A set of threads that will run a list of jobs. More...
Classes | |
| class | JobSelector |
| A callback class used when you need to select which ThreadPoolJob objects are suitable for some kind of operation. More... | |
Public Member Functions | |
| ThreadPool (int numberOfThreads) | |
| Creates a thread pool. More... | |
| ThreadPool () | |
| Creates a thread pool with one thread per CPU core. More... | |
| ~ThreadPool () | |
| Destructor. More... | |
| void | addJob (ThreadPoolJob *job, bool deleteJobWhenFinished) |
| Adds a job to the queue. More... | |
| bool | removeJob (ThreadPoolJob *job, bool interruptIfRunning, int timeOutMilliseconds) |
| Tries to remove a job from the pool. More... | |
| bool | removeAllJobs (bool interruptRunningJobs, int timeOutMilliseconds, JobSelector *selectedJobsToRemove=nullptr) |
| Tries to remove all jobs from the pool. More... | |
| int | getNumJobs () const |
| Returns the number of jobs currently running or queued. More... | |
| ThreadPoolJob * | getJob (int index) const |
| Returns one of the jobs in the queue. More... | |
| bool | contains (const ThreadPoolJob *job) const |
| Returns true if the given job is currently queued or running. More... | |
| bool | isJobRunning (const ThreadPoolJob *job) const |
| Returns true if the given job is currently being run by a thread. More... | |
| bool | waitForJobToFinish (const ThreadPoolJob *job, int timeOutMilliseconds) const |
| Waits until a job has finished running and has been removed from the pool. More... | |
| StringArray | getNamesOfAllJobs (bool onlyReturnActiveJobs) const |
| Returns a list of the names of all the jobs currently running or queued. More... | |
| bool | setThreadPriorities (int newPriority) |
| Changes the priority of all the threads. More... | |
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.
| ThreadPool::ThreadPool | ( | int | numberOfThreads | ) |
Creates a thread pool.
Once you've created a pool, you can give it some jobs by calling addJob().
| numberOfThreads | the number of threads to run. These will be started immediately, and will run until the pool is deleted. |
| ThreadPool::ThreadPool | ( | ) |
Creates a thread pool with one thread per CPU core.
Once you've created a pool, you can give it some jobs by calling addJob(). If you want to specify the number of threads, use the other constructor; this one creates a pool which has one thread for each CPU core.
| ThreadPool::~ThreadPool | ( | ) |
Destructor.
This will attempt to remove all the jobs before deleting, but if you want to specify a timeout, you should call removeAllJobs() explicitly before deleting the pool.
| void ThreadPool::addJob | ( | ThreadPoolJob * | job, |
| bool | deleteJobWhenFinished | ||
| ) |
Adds a job to the queue.
Once a job has been added, then the next time a thread is free, it will run the job's ThreadPoolJob::runJob() method. Depending on the return value of the runJob() method, the pool will either remove the job from the pool or add it to the back of the queue to be run again.
If deleteJobWhenFinished is true, then the job object will be owned and deleted by the pool when not needed - if you do this, make sure that your object's destructor is thread-safe.
If deleteJobWhenFinished is false, the pointer will be used but not deleted, and the caller is responsible for making sure the object is not deleted before it has been removed from the pool.
| bool ThreadPool::removeJob | ( | ThreadPoolJob * | job, |
| bool | interruptIfRunning, | ||
| int | timeOutMilliseconds | ||
| ) |
Tries to remove a job from the pool.
If the job isn't yet running, this will simply remove it. If it is running, it will wait for it to finish.
If the timeout period expires before the job finishes running, then the job will be left in the pool and this will return false. It returns true if the job is successfully stopped and removed.
| job | the job to remove |
| interruptIfRunning | if true, then if the job is currently busy, its ThreadPoolJob::signalJobShouldExit() method will be called to try to interrupt it. If false, then if the job will be allowed to run until it stops normally (or the timeout expires) |
| timeOutMilliseconds | the length of time this method should wait for the job to finish before giving up and returning false |
| bool ThreadPool::removeAllJobs | ( | bool | interruptRunningJobs, |
| int | timeOutMilliseconds, | ||
| JobSelector * | selectedJobsToRemove = nullptr |
||
| ) |
Tries to remove all jobs from the pool.
| interruptRunningJobs | if true, then all running jobs will have their ThreadPoolJob::signalJobShouldExit() methods called to try to interrupt them |
| timeOutMilliseconds | the length of time this method should wait for all the jobs to finish before giving up and returning false |
| selectedJobsToRemove | if this is non-zero, the JobSelector object is asked to decide which jobs should be removed. If it is zero, all jobs are removed |
| int ThreadPool::getNumJobs | ( | ) | const |
Returns the number of jobs currently running or queued.
| ThreadPoolJob* ThreadPool::getJob | ( | int | index | ) | const |
Returns one of the jobs in the queue.
Note that this can be a very volatile list as jobs might be continuously getting shifted around in the list, and this method may return nullptr if the index is currently out-of-range.
| bool ThreadPool::contains | ( | const ThreadPoolJob * | job | ) | const |
Returns true if the given job is currently queued or running.
| bool ThreadPool::isJobRunning | ( | const ThreadPoolJob * | job | ) | const |
Returns true if the given job is currently being run by a thread.
| bool ThreadPool::waitForJobToFinish | ( | const ThreadPoolJob * | job, |
| int | timeOutMilliseconds | ||
| ) | const |
Waits until a job has finished running and has been removed from the pool.
This will wait until the job is no longer in the pool - i.e. until its runJob() method returns ThreadPoolJob::jobHasFinished.
If the timeout period expires before the job finishes, this will return false; it returns true if the job has finished successfully.
| StringArray ThreadPool::getNamesOfAllJobs | ( | bool | onlyReturnActiveJobs | ) | const |
Returns a list of the names of all the jobs currently running or queued.
If onlyReturnActiveJobs is true, only the ones currently running are returned.
| bool ThreadPool::setThreadPriorities | ( | int | newPriority | ) |
Changes the priority of all the threads.
This will call Thread::setPriority() for each thread in the pool. May return false if for some reason the priority can't be changed.
