blob: 879e96b168f3d883a894d7752c98b37dae3db4a6 (
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtCore module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:COMM$
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** $QT_END_LICENSE$
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
****************************************************************************/
#include "qrunnable.h"
QT_BEGIN_NAMESPACE
QRunnable::~QRunnable()
{
// Must be empty until ### Qt 6
}
/*!
\class QRunnable
\inmodule QtCore
\since 4.4
\brief The QRunnable class is the base class for all runnable objects.
\ingroup thread
The QRunnable class is an interface for representing a task or
piece of code that needs to be executed, represented by your
reimplementation of the run() function.
You can use QThreadPool to execute your code in a separate
thread. QThreadPool deletes the QRunnable automatically if
autoDelete() returns \c true (the default). Use setAutoDelete() to
change the auto-deletion flag.
QThreadPool supports executing the same QRunnable more than once
by calling QThreadPool::tryStart(this) from within the run() function.
If autoDelete is enabled the QRunnable will be deleted when
the last thread exits the run function. Calling QThreadPool::start()
multiple times with the same QRunnable when autoDelete is enabled
creates a race condition and is not recommended.
\sa QThreadPool
*/
/*! \fn QRunnable::run()
Implement this pure virtual function in your subclass.
*/
/*! \fn QRunnable::QRunnable()
Constructs a QRunnable. Auto-deletion is enabled by default.
\sa autoDelete(), setAutoDelete()
*/
/*! \fn QRunnable::~QRunnable()
QRunnable virtual destructor.
*/
/*! \fn bool QRunnable::autoDelete() const
Returns \c true is auto-deletion is enabled; false otherwise.
If auto-deletion is enabled, QThreadPool will automatically delete
this runnable after calling run(); otherwise, ownership remains
with the application programmer.
\sa setAutoDelete(), QThreadPool
*/
/*! \fn bool QRunnable::setAutoDelete(bool autoDelete)
Enables auto-deletion if \a autoDelete is true; otherwise
auto-deletion is disabled.
If auto-deletion is enabled, QThreadPool will automatically delete
this runnable after calling run(); otherwise, ownership remains
with the application programmer.
Note that this flag must be set before calling
QThreadPool::start(). Calling this function after
QThreadPool::start() results in undefined behavior.
\sa autoDelete(), QThreadPool
*/
class FunctionRunnable : public QRunnable
{
std::function<void()> m_functionToRun;
public:
FunctionRunnable(std::function<void()> functionToRun) : m_functionToRun(std::move(functionToRun))
{
}
void run() override
{
m_functionToRun();
}
};
/*!
\since 5.15
Creates a QRunnable that calls \a functionToRun in run().
Auto-deletion is enabled by default.
\sa run(), autoDelete()
*/
QRunnable *QRunnable::create(std::function<void()> functionToRun)
{
return new FunctionRunnable(std::move(functionToRun));
}
QT_END_NAMESPACE
|