Encapsulates a thread. More...
Inherited by InterprocessConnection, InterprocessConnectionServer [private], MidiOutput [private], ThreadWithProgressWindow, and TimeSliceThread.
Public Types | |
| typedef void * | ThreadID |
| A value type used for thread IDs. | |
Public Member Functions | |
| Thread (const String &threadName) | |
| Creates a thread. | |
| virtual | ~Thread () |
| Destructor. | |
| virtual void | run ()=0 |
| Must be implemented to perform the thread's actual code. | |
| void | startThread () |
| Starts the thread running. | |
| void | startThread (int priority) |
| Starts the thread with a given priority. | |
| void | stopThread (int timeOutMilliseconds) |
| Attempts to stop the thread running. | |
| bool | isThreadRunning () const |
| Returns true if the thread is currently active. | |
| void | signalThreadShouldExit () |
| Sets a flag to tell the thread it should stop. | |
| bool | threadShouldExit () const |
| Checks whether the thread has been told to stop running. | |
| bool | waitForThreadToExit (int timeOutMilliseconds) const |
| Waits for the thread to stop. | |
| bool | setPriority (int priority) |
| Changes the thread's priority. | |
| void | setAffinityMask (uint32 affinityMask) |
| Sets the affinity mask for the thread. | |
| bool | wait (int timeOutMilliseconds) const |
| Makes the thread wait for a notification. | |
| void | notify () const |
| Wakes up the thread. | |
| ThreadID | getThreadId () const noexcept |
| Returns the ID of this thread. | |
| const String & | getThreadName () const |
| Returns the name of the thread. | |
Static Public Member Functions | |
| static bool | setCurrentThreadPriority (int priority) |
| Changes the priority of the caller thread. | |
| static void | setCurrentThreadAffinityMask (uint32 affinityMask) |
| Changes the affinity mask for the caller thread. | |
| static void JUCE_CALLTYPE | sleep (int milliseconds) |
| static void JUCE_CALLTYPE | yield () |
| Yields the calling thread's current time-slot. | |
| static ThreadID | getCurrentThreadId () |
| Returns an id that identifies the caller thread. | |
| static Thread * | getCurrentThread () |
| Finds the thread object that is currently running. | |
| static void | setCurrentThreadName (const String &newThreadName) |
| Changes the name of the caller thread. | |
| static int | getNumRunningThreads () |
| Returns the number of currently-running threads. | |
| static void | stopAllThreads (int timeoutInMillisecs) |
| Tries to stop all currently-running threads. | |
Encapsulates a thread.
Subclasses derive from Thread and implement the run() method, in which they do their business. The thread can then be started with the startThread() method and controlled with various other methods.
This class also contains some thread-related static methods, such as sleep(), yield(), getCurrentThreadId() etc.
| typedef void* Thread::ThreadID |
A value type used for thread IDs.
| Thread::Thread | ( | const String & | threadName ) | [explicit] |
Creates a thread.
When first created, the thread is not running. Use the startThread() method to start it.
| virtual Thread::~Thread | ( | ) | [virtual] |
Destructor.
Deleting a Thread object that is running will only give the thread a brief opportunity to stop itself cleanly, so it's recommended that you should always call stopThread() with a decent timeout before deleting, to avoid the thread being forcibly killed (which is a Bad Thing).
| virtual void Thread::run | ( | ) | [pure virtual] |
Must be implemented to perform the thread's actual code.
Remember that the thread must regularly check the threadShouldExit() method whilst running, and if this returns true it should return from the run() method as soon as possible to avoid being forcibly killed.
Implemented in MidiOutput.
| void Thread::startThread | ( | ) |
Starts the thread running.
This will start the thread's run() method. (if it's already started, startThread() won't do anything).
| void Thread::startThread | ( | int | priority ) |
Starts the thread with a given priority.
Launches the thread with a given priority, where 0 = lowest, 10 = highest. If the thread is already running, its priority will be changed.
| void Thread::stopThread | ( | int | timeOutMilliseconds ) |
Attempts to stop the thread running.
This method will cause the threadShouldExit() method to return true and call notify() in case the thread is currently waiting.
Hopefully the thread will then respond to this by exiting cleanly, and the stopThread method will wait for a given time-period for this to happen.
If the thread is stuck and fails to respond after the time-out, it gets forcibly killed, which is a very bad thing to happen, as it could still be holding locks, etc. which are needed by other parts of your program.
| timeOutMilliseconds | The number of milliseconds to wait for the thread to finish before killing it by force. A negative value in here will wait forever. |
| bool Thread::isThreadRunning | ( | ) | const |
Returns true if the thread is currently active.
| void Thread::signalThreadShouldExit | ( | ) |
Sets a flag to tell the thread it should stop.
Calling this means that the threadShouldExit() method will then return true. The thread should be regularly checking this to see whether it should exit.
If your thread makes use of wait(), you might want to call notify() after calling this method, to interrupt any waits that might be in progress, and allow it to reach a point where it can exit.
| bool Thread::threadShouldExit | ( | ) | const |
Checks whether the thread has been told to stop running.
Threads need to check this regularly, and if it returns true, they should return from their run() method at the first possible opportunity.
| bool Thread::waitForThreadToExit | ( | int | timeOutMilliseconds ) | const |
Waits for the thread to stop.
This will waits until isThreadRunning() is false or until a timeout expires.
| timeOutMilliseconds | the time to wait, in milliseconds. If this value is less than zero, it will wait forever. |
| bool Thread::setPriority | ( | int | priority ) |
Changes the thread's priority.
May return false if for some reason the priority can't be changed.
| priority | the new priority, in the range 0 (lowest) to 10 (highest). A priority of 5 is normal. |
| static bool Thread::setCurrentThreadPriority | ( | int | priority ) | [static] |
Changes the priority of the caller thread.
Similar to setPriority(), but this static method acts on the caller thread. May return false if for some reason the priority can't be changed.
| void Thread::setAffinityMask | ( | uint32 | affinityMask ) |
Sets the affinity mask for the thread.
This will only have an effect next time the thread is started - i.e. if the thread is already running when called, it'll have no effect.
| static void Thread::setCurrentThreadAffinityMask | ( | uint32 | affinityMask ) | [static] |
Changes the affinity mask for the caller thread.
This will change the affinity mask for the thread that calls this static method.
| static void JUCE_CALLTYPE Thread::sleep | ( | int | milliseconds ) | [static] |
| static void JUCE_CALLTYPE Thread::yield | ( | ) | [static] |
Yields the calling thread's current time-slot.
| bool Thread::wait | ( | int | timeOutMilliseconds ) | const |
Makes the thread wait for a notification.
This puts the thread to sleep until either the timeout period expires, or another thread calls the notify() method to wake it up.
A negative time-out value means that the method will wait indefinitely.
| void Thread::notify | ( | ) | const |
| static ThreadID Thread::getCurrentThreadId | ( | ) | [static] |
Returns an id that identifies the caller thread.
To find the ID of a particular thread object, use getThreadId().
| static Thread* Thread::getCurrentThread | ( | ) | [static] |
Finds the thread object that is currently running.
Note that the main UI thread (or other non-Juce threads) don't have a Thread object associated with them, so this will return 0.
| ThreadID Thread::getThreadId | ( | ) | const |
Returns the ID of this thread.
That means the ID of this thread object - not of the thread that's calling the method.
This can change when the thread is started and stopped, and will be invalid if the thread's not actually running.
| const String& Thread::getThreadName | ( | ) | const |
Returns the name of the thread.
This is the name that gets set in the constructor.
| static void Thread::setCurrentThreadName | ( | const String & | newThreadName ) | [static] |
Changes the name of the caller thread.
Different OSes may place different length or content limits on this name.
| static int Thread::getNumRunningThreads | ( | ) | [static] |
Returns the number of currently-running threads.
| static void Thread::stopAllThreads | ( | int | timeoutInMillisecs ) | [static] |
Tries to stop all currently-running threads.
This will attempt to stop all the threads known to be running at the moment.
