OpenShot Library | libopenshot-audio
0.1.9
|
A task that is executed by a ThreadPool object. More...
#include <juce_ThreadPool.h>
Public Types | |
enum | JobStatus { jobHasFinished = 0, jobNeedsRunningAgain } |
These are the values that can be returned by the runJob() method. More... | |
Public Member Functions | |
ThreadPoolJob (const String &name) | |
Creates a thread pool job object. More... | |
virtual | ~ThreadPoolJob () |
Destructor. More... | |
String | getJobName () const |
Returns the name of this job. More... | |
void | setJobName (const String &newName) |
Changes the job's name. More... | |
virtual JobStatus | runJob ()=0 |
Peforms the actual work that this job needs to do. More... | |
bool | isRunning () const noexcept |
Returns true if this job is currently running its runJob() method. More... | |
bool | shouldExit () const noexcept |
Returns true if something is trying to interrupt this job and make it stop. More... | |
void | signalJobShouldExit () |
Calling this will cause the shouldExit() method to return true, and the job should (if it's been implemented correctly) stop as soon as possible. More... | |
void | addListener (Thread::Listener *) |
Add a listener to this thread job which will receive a callback when signalJobShouldExit was called on this thread job. More... | |
void | removeListener (Thread::Listener *) |
Removes a listener added with addListener. More... | |
Static Public Member Functions | |
static ThreadPoolJob * | getCurrentThreadPoolJob () |
If the calling thread is being invoked inside a runJob() method, this will return the ThreadPoolJob that it belongs to. | |
Friends | |
class | ThreadPool |
A task that is executed by a ThreadPool object.
A ThreadPool keeps a list of ThreadPoolJob objects which are executed by its threads.
The runJob() method needs to be implemented to do the task, and if the code that does the work takes a significant time to run, it must keep checking the shouldExit() method to see if something is trying to interrupt the job. If shouldExit() returns true, the runJob() method must return immediately.
Definition at line 48 of file juce_ThreadPool.h.
These are the values that can be returned by the runJob() method.
Enumerator | |
---|---|
jobHasFinished | indicates that the job has finished and can be removed from the pool. |
jobNeedsRunningAgain | indicates that the job would like to be called again when a thread is free. |
Definition at line 74 of file juce_ThreadPool.h.
|
explicit |
Creates a thread pool job object.
After creating your job, add it to a thread pool with ThreadPool::addJob().
Definition at line 47 of file juce_ThreadPool.cpp.
Referenced by juce::ThreadPool::addJob().
|
virtual |
Destructor.
Definition at line 51 of file juce_ThreadPool.cpp.
References juce::ThreadPool::contains().
String juce::ThreadPoolJob::getJobName | ( | ) | const |
void juce::ThreadPoolJob::setJobName | ( | const String & | newName | ) |
|
pure virtual |
Peforms the actual work that this job needs to do.
Your subclass must implement this method, in which is does its work.
If the code in this method takes a significant time to run, it must repeatedly check the shouldExit() method to see if something is trying to interrupt the job. If shouldExit() ever returns true, the runJob() method must return immediately.
If this method returns jobHasFinished, then the job will be removed from the pool immediately. If it returns jobNeedsRunningAgain, then the job will be left in the pool and will get a chance to run again as soon as a thread is free.
Referenced by juce::ThreadPool::addJob().
|
inlinenoexcept |
Returns true if this job is currently running its runJob() method.
Definition at line 102 of file juce_ThreadPool.h.
|
inlinenoexcept |
Returns true if something is trying to interrupt this job and make it stop.
Your runJob() method must call this whenever it gets a chance, and if it ever returns true, the runJob() method must return immediately.
Definition at line 111 of file juce_ThreadPool.h.
Referenced by juce::MessageManagerLock::MessageManagerLock().
void juce::ThreadPoolJob::signalJobShouldExit | ( | ) |
Calling this will cause the shouldExit() method to return true, and the job should (if it's been implemented correctly) stop as soon as possible.
Definition at line 68 of file juce_ThreadPool.cpp.
References juce::Thread::Listener::exitSignalSent().
Referenced by juce::ThreadPool::removeJob().
void juce::ThreadPoolJob::addListener | ( | Thread::Listener * | listener | ) |
Add a listener to this thread job which will receive a callback when signalJobShouldExit was called on this thread job.
Definition at line 74 of file juce_ThreadPool.cpp.
Referenced by juce::MessageManagerLock::MessageManagerLock().
void juce::ThreadPoolJob::removeListener | ( | Thread::Listener * | listener | ) |
Removes a listener added with addListener.
Definition at line 79 of file juce_ThreadPool.cpp.
Referenced by juce::MessageManagerLock::MessageManagerLock().