openshot-audio  0.1.7
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
Thread Class Referenceabstract

#include <juce_Thread.h>

Inheritance diagram for Thread:
AndroidAudioIODevice ChildProcessPingThread CoreAudioClasses::AudioIODeviceCombiner InterprocessConnection::ConnectionThread InterprocessConnectionServer MidiOutput OpenSLAudioIODevice ThreadPool::ThreadPoolThread ThreadWithProgressWindow Timer::TimerThread TimeSliceThread URLConnectionState WasapiClasses::WASAPIAudioIODevice

Public Types

typedef void * ThreadID
 

Public Member Functions

 Thread (const String &threadName)
 
virtual ~Thread ()
 
virtual void run ()=0
 
void startThread ()
 
void startThread (int priority)
 
bool stopThread (int timeOutMilliseconds)
 
bool isThreadRunning () const
 
void signalThreadShouldExit ()
 
bool threadShouldExit () const
 
bool waitForThreadToExit (int timeOutMilliseconds) const
 
bool setPriority (int priority)
 
void setAffinityMask (uint32 affinityMask)
 
bool wait (int timeOutMilliseconds) const
 
void notify () const
 
ThreadID getThreadId () const noexcept
 
const StringgetThreadName () const
 

Static Public Member Functions

static bool setCurrentThreadPriority (int priority)
 
static void JUCE_CALLTYPE setCurrentThreadAffinityMask (uint32 affinityMask)
 
static void JUCE_CALLTYPE sleep (int milliseconds)
 
static void JUCE_CALLTYPE yield ()
 
static ThreadID JUCE_CALLTYPE getCurrentThreadId ()
 
static Thread *JUCE_CALLTYPE getCurrentThread ()
 
static void JUCE_CALLTYPE setCurrentThreadName (const String &newThreadName)
 

Friends

void JUCE_API juce_threadEntryPoint (void *)
 

Detailed Description

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.

See also
CriticalSection, WaitableEvent, Process, ThreadWithProgressWindow, MessageManagerLock

Member Typedef Documentation

◆ ThreadID

typedef void* Thread::ThreadID

A value type used for thread IDs.

See also
getCurrentThreadId(), getThreadId()

Constructor & Destructor Documentation

◆ Thread()

Thread::Thread ( const String threadName)
explicit

Creates a thread.

When first created, the thread is not running. Use the startThread() method to start it.

◆ ~Thread()

Thread::~Thread ( )
virtual

Destructor.

You must never attempt to delete a Thread object while it's still running - always call stopThread() and make sure your thread has stopped before deleting the object. Failing to do so will throw an assertion, and put you firmly into undefined behaviour territory.

Member Function Documentation

◆ getCurrentThread()

Thread *JUCE_CALLTYPE 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 nullptr.

◆ getCurrentThreadId()

Thread::ThreadID JUCE_CALLTYPE Thread::getCurrentThreadId ( )
static

Returns an id that identifies the caller thread.

To find the ID of a particular thread object, use getThreadId().

Returns
a unique identifier that identifies the calling thread.
See also
getThreadId

◆ getThreadId()

ThreadID Thread::getThreadId ( ) const
inlinenoexcept

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.

See also
getCurrentThreadId

◆ getThreadName()

const String& Thread::getThreadName ( ) const
inline

Returns the name of the thread.

This is the name that gets set in the constructor.

◆ isThreadRunning()

bool Thread::isThreadRunning ( ) const

Returns true if the thread is currently active

◆ notify()

void Thread::notify ( ) const

Wakes up the thread.

If the thread has called the wait() method, this will wake it up.

See also
wait

◆ run()

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.

See also
threadShouldExit, startThread

Implemented in WasapiClasses::WASAPIAudioIODevice, AndroidAudioIODevice, URLConnectionState, TimeSliceThread, Timer::TimerThread, ThreadPool::ThreadPoolThread, and InterprocessConnection::ConnectionThread.

◆ setAffinityMask()

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.

See also
setCurrentThreadAffinityMask

◆ setCurrentThreadAffinityMask()

void JUCE_CALLTYPE 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.

See also
setAffinityMask

◆ setCurrentThreadName()

void JUCE_CALLTYPE 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.

◆ setCurrentThreadPriority()

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.

See also
setPriority

◆ setPriority()

bool Thread::setPriority ( int  priority)

Changes the thread's priority. May return false if for some reason the priority can't be changed.

Parameters
prioritythe new priority, in the range 0 (lowest) to 10 (highest). A priority of 5 is normal.

◆ signalThreadShouldExit()

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.

See also
threadShouldExit
waitForThreadToExit

◆ sleep()

void JUCE_CALLTYPE Thread::sleep ( int  milliseconds)
static

◆ startThread() [1/2]

void Thread::startThread ( )

Starts the thread running.

This will cause the thread's run() method to be called by a new thread. If this thread is already running, startThread() won't do anything.

See also
stopThread

◆ startThread() [2/2]

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.

See also
startThread, setPriority

◆ stopThread()

bool 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.

Parameters
timeOutMillisecondsThe number of milliseconds to wait for the thread to finish before killing it by force. A negative value in here will wait forever.
Returns
true if the thread was cleanly stopped before the timeout, or false if it had to be killed by force.
See also
signalThreadShouldExit, threadShouldExit, waitForThreadToExit, isThreadRunning

◆ threadShouldExit()

bool Thread::threadShouldExit ( ) const
inline

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.

See also
signalThreadShouldExit

◆ wait()

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.

Returns
true if the event has been signalled, false if the timeout expires.

◆ waitForThreadToExit()

bool Thread::waitForThreadToExit ( int  timeOutMilliseconds) const

Waits for the thread to stop.

This will waits until isThreadRunning() is false or until a timeout expires.

Parameters
timeOutMillisecondsthe time to wait, in milliseconds. If this value is less than zero, it will wait forever.
Returns
true if the thread exits, or false if the timeout expires first.

◆ yield()

void Thread::yield ( )
static

Yields the calling thread's current time-slot.

Friends And Related Function Documentation

◆ juce_threadEntryPoint

void JUCE_API juce_threadEntryPoint ( void *  userData)
friend

The documentation for this class was generated from the following files: