juce_Thread.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   The code included in this file is provided under the terms of the ISC license
   http://www.isc.org/downloads/software-support-policy/isc-license. Permission
   To use, copy, modify, and/or distribute this software for any purpose with or
   without fee is hereby granted provided that the above copyright notice and
   this permission notice appear in all copies.
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  Thread
{
public:
    //==============================================================================
    explicit Thread (const String& threadName, size_t threadStackSize = 0);

    virtual ~Thread();
 
    //==============================================================================
    virtual void run() = 0;
 
    //==============================================================================
    void startThread();

    void startThread (int priority);

    bool stopThread (int timeOutMilliseconds);
 
    //==============================================================================
    static void launch (std::function<void()> functionToRun);
 
    //==============================================================================
    bool isThreadRunning() const;

    void signalThreadShouldExit();

    bool threadShouldExit() const;

    static bool currentThreadShouldExit();

    bool waitForThreadToExit (int timeOutMilliseconds) const;
 
    //==============================================================================
    class JUCE_API Listener
    {
    public:
        virtual ~Listener() = default;

        virtual void exitSignalSent() = 0;
    };

    void addListener (Listener*);

    void removeListener (Listener*);
 
    //==============================================================================
    enum
    {
        realtimeAudioPriority = -1
    };

    bool setPriority (int priority);

    static bool setCurrentThreadPriority (int priority);
 
    //==============================================================================
    void setAffinityMask (uint32 affinityMask);

    static void JUCE_CALLTYPE setCurrentThreadAffinityMask (uint32 affinityMask);
 
    //==============================================================================
    static void JUCE_CALLTYPE sleep (int milliseconds);

    static void JUCE_CALLTYPE yield();
 
    //==============================================================================
    bool wait (int timeOutMilliseconds) const;

    void notify() const;
 
    //==============================================================================
    using ThreadID = void*;

    static ThreadID JUCE_CALLTYPE getCurrentThreadId();

    static Thread* JUCE_CALLTYPE getCurrentThread();

    ThreadID getThreadId() const noexcept;

    const String& getThreadName() const noexcept                    { return threadName; }

    static void JUCE_CALLTYPE setCurrentThreadName (const String& newThreadName);
 
   #if JUCE_ANDROID || DOXYGEN
    //==============================================================================
    static void initialiseJUCE (void* jniEnv, void* jContext);
   #endif
 
private:
    //==============================================================================
    const String threadName;
    Atomic<void*> threadHandle { nullptr };
    Atomic<ThreadID> threadId = {};
    CriticalSection startStopLock;
    WaitableEvent startSuspensionEvent, defaultEvent;
    int threadPriority = 5;
    size_t threadStackSize;
    uint32 affinityMask = 0;
    bool deleteOnThreadEnd = false;
    Atomic<int32> shouldExit { 0 };
    ListenerList<Listener, Array<Listener*, CriticalSection>> listeners;
 
   #if JUCE_ANDROID
    bool isAndroidRealtimeThread = false;
   #endif
 
   #ifndef DOXYGEN
    friend void JUCE_API juce_threadEntryPoint (void*);
   #endif
 
    void launchThread();
    void closeThreadHandle();
    void killThread();
    void threadEntryPoint();
    static bool setThreadPriority (void*, int);
    static int getAdjustedPriority (int);
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Thread)
};
 
} // namespace juce