summaryrefslogtreecommitdiffstats
path: root/src/corelib/thread/qthreadpool.h
blob: a097ace14bd9f8942d5030a142bd4279019455ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#ifndef QTHREADPOOL_H
#define QTHREADPOOL_H

#include <QtCore/qglobal.h>

#include <QtCore/qthread.h>
#include <QtCore/qrunnable.h>

#include <functional>

QT_REQUIRE_CONFIG(thread);

QT_BEGIN_NAMESPACE

class QThreadPoolPrivate;
class Q_CORE_EXPORT QThreadPool : public QObject
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QThreadPool)
    Q_PROPERTY(int expiryTimeout READ expiryTimeout WRITE setExpiryTimeout)
    Q_PROPERTY(int maxThreadCount READ maxThreadCount WRITE setMaxThreadCount)
    Q_PROPERTY(int activeThreadCount READ activeThreadCount)
    Q_PROPERTY(uint stackSize READ stackSize WRITE setStackSize)
    Q_PROPERTY(QThread::Priority threadPriority READ threadPriority WRITE setThreadPriority)
    friend class QFutureInterfaceBase;

public:
    QThreadPool(QObject *parent = nullptr);
    ~QThreadPool();

    static QThreadPool *globalInstance();

    void start(QRunnable *runnable, int priority = 0);
    bool tryStart(QRunnable *runnable);

#if QT_CORE_REMOVED_SINCE(6, 6)
    void start(std::function<void()> functionToRun, int priority = 0);
    bool tryStart(std::function<void()> functionToRun);
#endif

    void startOnReservedThread(QRunnable *runnable);
#if QT_CORE_REMOVED_SINCE(6, 6)
    void startOnReservedThread(std::function<void()> functionToRun);
#endif

    template <typename Callable, QRunnable::if_callable<Callable> = true>
    void start(Callable &&functionToRun, int priority = 0);
    template <typename Callable, QRunnable::if_callable<Callable> = true>
    bool tryStart(Callable &&functionToRun);
    template <typename Callable, QRunnable::if_callable<Callable> = true>
    void startOnReservedThread(Callable &&functionToRun);

    int expiryTimeout() const;
    void setExpiryTimeout(int expiryTimeout);

    int maxThreadCount() const;
    void setMaxThreadCount(int maxThreadCount);

    int activeThreadCount() const;

    void setStackSize(uint stackSize);
    uint stackSize() const;

    void setThreadPriority(QThread::Priority priority);
    QThread::Priority threadPriority() const;

    void reserveThread();
    void releaseThread();

    bool waitForDone(int msecs = -1);

    void clear();

    bool contains(const QThread *thread) const;

    [[nodiscard]] bool tryTake(QRunnable *runnable);
};

template <typename Callable, QRunnable::if_callable<Callable>>
void QThreadPool::start(Callable &&functionToRun, int priority)
{
    start(QRunnable::create(std::forward<Callable>(functionToRun)), priority);
}

template <typename Callable, QRunnable::if_callable<Callable>>
bool QThreadPool::tryStart(Callable &&functionToRun)
{
    QRunnable *runnable = QRunnable::create(std::forward<Callable>(functionToRun));
    if (tryStart(runnable))
        return true;
    delete runnable;
    return false;
}

template <typename Callable, QRunnable::if_callable<Callable>>
void QThreadPool::startOnReservedThread(Callable &&functionToRun)
{
    startOnReservedThread(QRunnable::create(std::forward<Callable>(functionToRun)));
}

QT_END_NAMESPACE

#endif