qthread.h [include/QtCore/qthread.h]

1	/****************************************************************************
2	**
3	** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4	** Contact: http://www.qt-project.org/
5	**
6	** This file is part of the QtCore module of the Qt Toolkit.
7	**
8	** $QT_BEGIN_LICENSE:LGPL$
9	** GNU Lesser General Public License Usage
10	** This file may be used under the terms of the GNU Lesser General Public
11	** License version 2.1 as published by the Free Software Foundation and
12	** appearing in the file LICENSE.LGPL included in the packaging of this
13	** file. Please review the following information to ensure the GNU Lesser
14	** General Public License version 2.1 requirements will be met:
15	** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
16	**
17	** In addition, as a special exception, Nokia gives you certain additional
18	** rights. These rights are described in the Nokia Qt LGPL Exception
19	** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
20	**
21	** GNU General Public License Usage
22	** Alternatively, this file may be used under the terms of the GNU General
23	** Public License version 3.0 as published by the Free Software Foundation
24	** and appearing in the file LICENSE.GPL included in the packaging of this
25	** file. Please review the following information to ensure the GNU General
26	** Public License version 3.0 requirements will be met:
27	** http://www.gnu.org/copyleft/gpl.html.
28	**
29	** Other Usage
30	** Alternatively, this file may be used in accordance with the terms and
31	** conditions contained in a signed written agreement between you and Nokia.
32	**
33	**
34	**
35	**
36	**
37	**
38	** $QT_END_LICENSE$
39	**
40	****************************************************************************/
41
42	#ifndef QTHREAD_H
43	#define QTHREAD_H
44
45	#include <QtCore/qobject.h>
46
47	#include <limits.h>
48
49	QT_BEGIN_HEADER
50
51	QT_BEGIN_NAMESPACE
52
53	QT_MODULE(Core)
54
55	class QThreadData;
56	class QThreadPrivate;
57
58	#ifndef QT_NO_THREAD
59	class Q_CORE_EXPORT QThread : public QObject
60	{
61	public:
62	static Qt::HANDLE currentThreadId();
63	static QThread *currentThread();
64	static int idealThreadCount();
65	static void yieldCurrentThread();
66
67	explicit QThread(QObject *parent = `0`);
68	~QThread();
69
70	enum Priority {
71	IdlePriority,
72
73	LowestPriority,
74	LowPriority,
75	NormalPriority,
76	HighPriority,
77	HighestPriority,
78
79	TimeCriticalPriority,
80
81	InheritPriority
82	};
83
84	void setPriority(Priority priority);
85	Priority priority() const;
86
87	bool isFinished() const;
88	bool isRunning() const;
89
90	void setStackSize(uint stackSize);
91	uint stackSize() const;
92
93	void exit(int retcode = `0`);
94
95	public Q_SLOTS:
96	void start(Priority = InheritPriority);
97	void terminate();
98	void quit();
99
100	public:
101	// default argument causes thread to block indefinately
102	bool wait(unsigned long time = ULONG_MAX);
103
104	Q_SIGNALS:
105	void started();
106	void finished();
107	void terminated();
108
109	protected:
110	virtual void run();
111	int exec();
112
113	static void setTerminationEnabled(bool enabled = true);
114
115	static void sleep(unsigned long);
116	static void msleep(unsigned long);
117	static void usleep(unsigned long);
118
119	#ifdef QT3_SUPPORT
120	public:
121	inline QT3_SUPPORT bool finished() const { return isFinished(); }
122	inline QT3_SUPPORT bool running() const { return isRunning(); }
123	#endif
124
125	protected:
126	QThread(QThreadPrivate &dd, QObject *parent = `0`);
127
128	private:
129	Q_OBJECT
130	Q_DECLARE_PRIVATE(QThread)
131
132	static void initialize();
133	static void cleanup();
134
135	friend class QCoreApplication;
136	friend class QThreadData;
137	};
138
139	#else // QT_NO_THREAD
140
141	class Q_CORE_EXPORT QThread : public QObject
142	{
143	public:
144	static Qt::HANDLE currentThreadId() { return Qt::HANDLE(currentThread()); }
145	static QThread* currentThread();
146
147	protected:
148	QThread(QThreadPrivate &dd, QObject *parent = `0`);
149
150	private:
151	explicit QThread(QObject *parent = `0`);
152	static QThread *instance;
153
154	friend class QCoreApplication;
155	friend class QThreadData;
156	friend class QAdoptedThread;
157	Q_DECLARE_PRIVATE(QThread)
158	};
159
160	#endif // QT_NO_THREAD
161
162	QT_END_NAMESPACE
163
164	QT_END_HEADER
165
166	#endif // QTHREAD_H
167