File: qthread.html

package info (click to toggle)
qt-embedded 2.3.2-3
  • links: PTS
  • area: main
  • in suites: woody
  • size: 68,608 kB
  • ctags: 45,998
  • sloc: cpp: 276,654; ansic: 71,987; makefile: 29,074; sh: 12,305; yacc: 2,465; python: 1,863; perl: 481; lex: 480; xml: 68; lisp: 15
file content (175 lines) | stat: -rw-r--r-- 8,776 bytes parent folder | download
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Qt Toolkit - QThread Class</title><style type="text/css"><!--
h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }body { background: white; color: black; }
--></style>
</head><body bgcolor="#ffffff">

<table width="100%">
<tr><td><a href="index.html">
<img width="100" height="100" src="qtlogo.png"
alt="Home" border="0"><img width="100"
height="100" src="face.png" alt="Home" border="0">
</a><td valign=top><div align=right><img src="dochead.png" width="472" height="27"><br>
<a href="classes.html"><b>Classes</b></a>
-<a href="annotated.html">Annotated</a>
- <a href="hierarchy.html">Tree</a>
-<a href="functions.html">Functions</a>
-<a href="index.html">Home</a>
-<a href="topicals.html"><b>Structure</b></a>
</div>
</table>

<h1 align=center>QThread Class Reference</h1><br clear="all">
<p>
The QThread class provides platform-independent threads
<a href="#details">More...</a>
<p>
<code>#include &lt;<a href="qthread-h.html">qthread.h</a>&gt;</code>
<p>
Inherits <a href="qt.html">Qt</a>.
<p><a href="qthread-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li><div class="fn"><a href="#7aabff"><b>QThread</b></a>()</div>
<li><div class="fn">virtual<a href="#54ba48"><b>~QThread</b></a>()</div>
<li><div class="fn">bool<a href="#5dec86"><b>wait</b></a>(unsignedlongtime=ULONG_MAX)</div>
<li><div class="fn">void<a href="#536ef2"><b>start</b></a>()</div>
<li><div class="fn">bool<a href="#be34d4"><b>finished</b></a>()const</div>
<li><div class="fn">bool<a href="#a0d1da"><b>running</b></a>()const</div>
</ul>
<h2>Static Public Members</h2>
<ul>
<li><div class="fn">HANDLE<a href="#ab0cf1"><b>currentThread</b></a>()</div>
<li><div class="fn">void<a href="#f0670e"><b>postEvent</b></a>(QObject*, QEvent*)</div>
<li><div class="fn">void<a href="#5782c2"><b>exit</b></a>()</div>
</ul>
<h2>Protected Members</h2>
<ul>
<li><div class="fn">virtualvoid<a href="#f1c9f8"><b>run</b></a>()</div>
</ul>
<h2>Static Protected Members</h2>
<ul>
<li><div class="fn">void<a href="#bd7b82"><b>sleep</b></a>(unsignedlong)</div>
<li><div class="fn">void<a href="#c0539e"><b>msleep</b></a>(unsignedlong)</div>
<li><div class="fn">void<a href="#5eabb5"><b>usleep</b></a>(unsignedlong)</div>
</ul>
<hr><h2><a name="details"></a>Detailed Description</h2>
The QThread class provides platform-independent threads
<p>
A QThread represents a separate thread of control within the program;
it shares all data with other threads within the process but
executes independently in the way that a separate program does on
a multitasking operating system. Instead of starting in main(),
however, QThreads begin executing in <a href="#f1c9f8">run</a>(), which you inherit
to provide your code. For instance:
<p><pre>  class MyThread : public QThread {

  public:

    virtual void run();

  };

  void MyThread::run()
  {
    for(int count=0;count&lt;20;count++) {
      <a href="#bd7b82">sleep</a>(1);
      <a href="qapplication.html#72e78c">qDebug</a>("Ping!");
    }
  }

  int main()
  {
      MyThread a;
      MyThread b;
      a.<a href="#536ef2">start</a>();
      b.<a href="#536ef2">start</a>();
      a.<a href="#5dec86">wait</a>();
      b.<a href="#5dec86">wait</a>();
  }
</pre>
<p>This will start two threads, each of which writes Ping! 20 times
to the screen and exits. The <a href="#5dec86">wait</a>() calls at the end of main() are
necessary because exiting main() ends the program, unceremoniously
killing all other threads. Each MyThread stops executing when it
reaches the end of MyThread::run(), just as an application does when
it leaves main().
<p>See also the paragraph on <a href="threads.html">Thread Support in Qt</a>

<hr><h2>Member Function Documentation</h2>
<h3 class="fn"><a name="7aabff"></a>QThread::QThread()</h3>
<p>Constructs a new thread. The thread does not actually begin executing
until <a href="#536ef2">start</a>() is called.
<h3 class="fn"><a name="54ba48"></a>QThread::~QThread() <code>[virtual]</code></h3>
<p>QThread destructor. Note that deleting a QThread object will not stop
the execution of the thread it represents, and that deleting a QThread
object while the thread is running is unsafe.
<h3 class="fn">HANDLE<a name="ab0cf1"></a>QThread::currentThread() <code>[static]</code></h3>
<p>This returns the thread handle of the currently executing thread.  The
handle returned by this function is used for internal reasons and
should not be used in any application code.
On Windows, the returned value is a pseudo handle for the current thread,
and it can not be used for numerical comparison.
<h3 class="fn">void<a name="5782c2"></a>QThread::exit() <code>[static]</code></h3>
<p>Ends execution of the calling thread and wakes up any threads waiting
for its termination.
<h3 class="fn">bool<a name="be34d4"></a>QThread::finished()const</h3>
<p>Returns TRUE is the thread is finished.
<h3 class="fn">void<a name="c0539e"></a>QThread::msleep(unsignedlongmsecs) <code>[staticprotected]</code></h3>
<p>System independent sleep.  This causes the current thread to sleep for
<em>msecs</em> milliseconds.
<h3 class="fn">void<a name="f0670e"></a>QThread::postEvent(<a href="qobject.html">QObject</a>*receiver, <a href="qevent.html">QEvent</a>*event) <code>[static]</code></h3>
<p>Provides a way of posting an event from a thread which is not the
event thread to an object. The event is put into a queue, then the
event thread is woken which then sends the event to the object.
It is important to note that the event handler for the event, when called,
will be called from the event thread and not from the thread calling
QThread::postEvent().
<p>Same as with <a href="qapplication.html#96d77e">QApplication::postEvent()</a>, <em>event</em> must be allocated on the
heap, as it is deleted when the event has been posted.
<h3 class="fn">void<a name="f1c9f8"></a>QThread::run() <code>[virtualprotected]</code></h3>
<p>This method is pure virtual, and it must be implemented in derived classes
in order to do useful work. Returning from this method will end execution
of the thread.
<h3 class="fn">bool<a name="a0d1da"></a>QThread::running()const</h3>
<p>Returns TRUE if the thread is running.
<h3 class="fn">void<a name="bd7b82"></a>QThread::sleep(unsignedlongsecs) <code>[staticprotected]</code></h3>
<p>System independent sleep.  This causes the current thread to sleep for
<em>secs</em> seconds.
<h3 class="fn">void<a name="536ef2"></a>QThread::start()</h3>
<p>This begins actual execution of the thread by calling <a href="#f1c9f8">run</a>(),
which should be reimplemented in a QThread subclass to contain your code.
If you try to start a thread that is already running, this call will
wait until the thread has finished, and then restart the thread.
<h3 class="fn">void<a name="5eabb5"></a>QThread::usleep(unsignedlongusecs) <code>[staticprotected]</code></h3>
<p>System independent sleep.  This causes the current thread to sleep for
<em>usecs</em> microseconds.
<h3 class="fn">bool<a name="5dec86"></a>QThread::wait(unsignedlongtime=ULONG_MAX)</h3>
<p>This allows similar functionality to POSIX pthread_join.  A thread
calling this will block until one of 2 conditions is met:
<ul>
<li> The thread associated with this QThread object has finished
execution (i.e. when it returns from <a href="#f1c9f8">run</a>() ).  This
function will return TRUE if the thread has finished.
It also returns TRUE if the thread has not been started yet.
<li> <em>time</em> milliseconds has elapsed.  If <em>time</em> is ULONG_MAX (default
argument), then the wait will never timeout (the thread must
return from run() ).  This function will return FALSE
if the wait timed out.
</ul>
<hr><p>
Search the documentation, FAQ, qt-interest archive and more (uses
<a href="http://www.trolltech.com">www.trolltech.com</a>):<br>
<form method=post action="http://www.trolltech.com/search.cgi">
<input type=hidden name="version" value="2.3.2"><nobr>
<input size="50" name="search"><input type=submit value="Search">
</nobr></form><hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>,
copyright &copy; 1995-2001
<a href="http://www.trolltech.com">Trolltech</a>, all rights reserved.<p><address><hr><div align="center">
<table width="100%" cellspacing="0" border="0"><tr>
<td>Copyright  2001 Trolltech<td><a href="http://www.trolltech.com/trademarks.html">Trademarks</a>
<td align="right"><div align="right">Qt version 2.3.2</div>
</table></div></address></body></html>