1 /**************************************************************************** 2 ** 3 ** Copyright (C) 2016 The Qt Company Ltd. 4 ** Contact: https://www.qt.io/licensing/ 5 ** 6 ** This file is part of the QtCore module of the Qt Toolkit. 7 ** 8 ** $QT_BEGIN_LICENSE:LGPL$ 9 ** Commercial License Usage 10 ** Licensees holding valid commercial Qt licenses may use this file in 11 ** accordance with the commercial license agreement provided with the 12 ** Software or, alternatively, in accordance with the terms contained in 13 ** a written agreement between you and The Qt Company. For licensing terms 14 ** and conditions see https://www.qt.io/terms-conditions. For further 15 ** information use the contact form at https://www.qt.io/contact-us. 16 ** 17 ** GNU Lesser General Public License Usage 18 ** Alternatively, this file may be used under the terms of the GNU Lesser 19 ** General Public License version 3 as published by the Free Software 20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the 21 ** packaging of this file. Please review the following information to 22 ** ensure the GNU Lesser General Public License version 3 requirements 23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. 24 ** 25 ** GNU General Public License Usage 26 ** Alternatively, this file may be used under the terms of the GNU 27 ** General Public License version 2.0 or (at your option) the GNU General 28 ** Public license version 3 or any later version approved by the KDE Free 29 ** Qt Foundation. The licenses are as published by the Free Software 30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 31 ** included in the packaging of this file. Please review the following 32 ** information to ensure the GNU General Public License requirements will 33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and 34 ** https://www.gnu.org/licenses/gpl-3.0.html. 35 ** 36 ** $QT_END_LICENSE$ 37 ** 38 ****************************************************************************/ 39 40 #ifndef QTHREADPOOL_H 41 #define QTHREADPOOL_H 42 43 #include <QtCore/qglobal.h> 44 45 #include <QtCore/qthread.h> 46 #include <QtCore/qrunnable.h> 47 48 #include <functional> 49 50 QT_REQUIRE_CONFIG(thread); 51 52 QT_BEGIN_NAMESPACE 53 54 55 class QThreadPoolPrivate; 56 class Q_CORE_EXPORT QThreadPool : public QObject 57 { 58 Q_OBJECT 59 Q_DECLARE_PRIVATE(QThreadPool) 60 Q_PROPERTY(int expiryTimeout READ expiryTimeout WRITE setExpiryTimeout) 61 Q_PROPERTY(int maxThreadCount READ maxThreadCount WRITE setMaxThreadCount) 62 Q_PROPERTY(int activeThreadCount READ activeThreadCount) 63 Q_PROPERTY(uint stackSize READ stackSize WRITE setStackSize) 64 friend class QFutureInterfaceBase; 65 66 public: 67 QThreadPool(QObject *parent = nullptr); 68 ~QThreadPool(); 69 70 static QThreadPool *globalInstance(); 71 72 void start(QRunnable *runnable, int priority = 0); 73 bool tryStart(QRunnable *runnable); 74 75 void start(std::function<void()> functionToRun, int priority = 0); 76 bool tryStart(std::function<void()> functionToRun); 77 78 int expiryTimeout() const; 79 void setExpiryTimeout(int expiryTimeout); 80 81 int maxThreadCount() const; 82 void setMaxThreadCount(int maxThreadCount); 83 84 int activeThreadCount() const; 85 86 void setStackSize(uint stackSize); 87 uint stackSize() const; 88 89 void reserveThread(); 90 void releaseThread(); 91 92 bool waitForDone(int msecs = -1); 93 94 void clear(); 95 96 bool contains(const QThread *thread) const; 97 98 #if QT_DEPRECATED_SINCE(5, 9) 99 QT_DEPRECATED_X("use tryTake(), but note the different deletion rules") 100 void cancel(QRunnable *runnable); 101 #endif 102 Q_REQUIRED_RESULT bool tryTake(QRunnable *runnable); 103 }; 104 105 QT_END_NAMESPACE 106 107 #endif 108