thread.html
5.82 KB
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
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>thread</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="this_coro__executor_t/executor_t.html" title="this_coro::executor_t::executor_t">
<link rel="next" href="thread/join.html" title="thread::join">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="this_coro__executor_t/executor_t.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="thread/join.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.thread"></a><a class="link" href="thread.html" title="thread">thread</a>
</h3></div></div></div>
<p>
A simple abstraction for starting threads.
</p>
<pre class="programlisting">class thread :
noncopyable
</pre>
<h5>
<a name="asio.reference.thread.h0"></a>
<span><a name="asio.reference.thread.member_functions"></a></span><a class="link" href="thread.html#asio.reference.thread.member_functions">Member
Functions</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<a class="link" href="thread/join.html" title="thread::join"><span class="bold"><strong>join</strong></span></a>
</p>
</td>
<td>
<p>
Wait for the thread to exit.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="thread/thread.html" title="thread::thread"><span class="bold"><strong>thread</strong></span></a>
<span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Start a new thread that executes the supplied function.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="thread/_thread.html" title="thread::~thread"><span class="bold"><strong>~thread</strong></span></a>
<span class="silver">[destructor]</span>
</p>
</td>
<td>
<p>
Destructor.
</p>
</td>
</tr>
</tbody>
</table></div>
<p>
The <a class="link" href="thread.html" title="thread"><code class="computeroutput">thread</code></a> class
implements the smallest possible subset of the functionality of boost::thread.
It is intended to be used only for starting a thread and waiting for it to
exit. If more extensive threading capabilities are required, you are strongly
advised to use something else.
</p>
<h5>
<a name="asio.reference.thread.h1"></a>
<span><a name="asio.reference.thread.thread_safety"></a></span><a class="link" href="thread.html#asio.reference.thread.thread_safety">Thread
Safety</a>
</h5>
<p>
<span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
</p>
<p>
<span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
</p>
<h5>
<a name="asio.reference.thread.h2"></a>
<span><a name="asio.reference.thread.example"></a></span><a class="link" href="thread.html#asio.reference.thread.example">Example</a>
</h5>
<p>
A typical use of <a class="link" href="thread.html" title="thread"><code class="computeroutput">thread</code></a>
would be to launch a thread to run an io_context's event processing loop:
</p>
<pre class="programlisting">asio::io_context io_context;
// ...
asio::thread t(boost::bind(&asio::io_context::run, &io_context));
// ...
t.join();
</pre>
<h5>
<a name="asio.reference.thread.h3"></a>
<span><a name="asio.reference.thread.requirements"></a></span><a class="link" href="thread.html#asio.reference.thread.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/thread.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
Kohlhoff<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="this_coro__executor_t/executor_t.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="thread/join.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>