juce_TimeSliceThread.h

/*
  ==============================================================================
 
   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 TimeSliceThread;
 
 
//==============================================================================
class JUCE_API  TimeSliceClient
{
public:
    virtual ~TimeSliceClient() = default;

    virtual int useTimeSlice() = 0;
 
 
private:
    friend class TimeSliceThread;
    Time nextCallTime;
};
 
 
//==============================================================================
class JUCE_API  TimeSliceThread   : public Thread
{
public:
    //==============================================================================
    explicit TimeSliceThread (const String& threadName);

    ~TimeSliceThread() override;
 
    //==============================================================================
    void addTimeSliceClient (TimeSliceClient* clientToAdd, int millisecondsBeforeStarting = 0);

    void moveToFrontOfQueue (TimeSliceClient* clientToMove);

    void removeTimeSliceClient (TimeSliceClient* clientToRemove);

    void removeAllClients();

    int getNumClients() const;

    TimeSliceClient* getClient (int index) const;

    bool contains (const TimeSliceClient*) const;
 
    //==============================================================================
   #ifndef DOXYGEN
    void run() override;
   #endif
 
    //==============================================================================
private:
    CriticalSection callbackLock, listLock;
    Array<TimeSliceClient*> clients;
    TimeSliceClient* clientBeingCalled = nullptr;
 
    TimeSliceClient* getNextClient (int index) const;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (TimeSliceThread)
};
 
} // namespace juce