Imported Upstream version 1.72.0
[platform/upstream/boost.git] / doc / html / thread.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5 <title>Chapter&#160;39.&#160;Thread 4.8.0</title>
6 <link rel="stylesheet" href="../../doc/src/boostbook.css" type="text/css">
7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8 <link rel="home" href="index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9 <link rel="up" href="libraries.html" title="Part&#160;I.&#160;The Boost C++ Libraries (BoostBook Subset)">
10 <link rel="prev" href="boost_staticassert/test.html" title="Test Programs">
11 <link rel="next" href="thread/build.html" title="Using and building the library">
12 </head>
13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14 <table cellpadding="2" width="100%"><tr>
15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../boost.png"></td>
16 <td align="center"><a href="../../index.html">Home</a></td>
17 <td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20 <td align="center"><a href="../../more/index.htm">More</a></td>
21 </tr></table>
22 <hr>
23 <div class="spirit-nav">
24 <a accesskey="p" href="boost_staticassert/test.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="libraries.html"><img src="../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="thread/build.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
25 </div>
26 <div class="chapter">
27 <div class="titlepage"><div>
28 <div><h2 class="title">
29 <a name="thread"></a>Chapter&#160;39.&#160;Thread 4.8.0</h2></div>
30 <div><div class="author"><h3 class="author">
31 <span class="firstname">Anthony</span> <span class="surname">Williams</span>
32 </h3></div></div>
33 <div><div class="author"><h3 class="author">
34 <span class="firstname">Vicente J.</span> <span class="surname">Botet Escriba</span>
35 </h3></div></div>
36 <div><p class="copyright">Copyright &#169; 2007 -11 Anthony Williams</p></div>
37 <div><p class="copyright">Copyright &#169; 2011 -17 Vicente J. Botet Escriba</p></div>
38 <div><div class="legalnotice">
39 <a name="thread.legal"></a><p>
40         Distributed under the Boost Software License, Version 1.0. (See accompanying
41         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>)
42       </p>
43 </div></div>
44 </div></div>
45 <div class="toc">
46 <p><b>Table of Contents</b></p>
47 <dl class="toc">
48 <dt><span class="section"><a href="thread.html#thread.overview">Overview</a></span></dt>
49 <dt><span class="section"><a href="thread/build.html">Using and building the library</a></span></dt>
50 <dd><dl>
51 <dt><span class="section"><a href="thread/build.html#thread.build.configuration">Configuration</a></span></dt>
52 <dt><span class="section"><a href="thread/build.html#thread.build.limitations">Limitations</a></span></dt>
53 </dl></dd>
54 <dt><span class="section"><a href="thread/changes.html">History</a></span></dt>
55 <dt><span class="section"><a href="thread/future.html">Future</a></span></dt>
56 <dt><span class="section"><a href="thread/thread_management.html">Thread Management</a></span></dt>
57 <dd><dl>
58 <dt><span class="section"><a href="thread/thread_management.html#thread.thread_management.synopsis">Synopsis</a></span></dt>
59 <dt><span class="section"><a href="thread/thread_management.html#thread.thread_management.tutorial">Tutorial</a></span></dt>
60 <dt><span class="section"><a href="thread/thread_management.html#thread.thread_management.thread">Class <code class="computeroutput"><span class="identifier">thread</span></code></a></span></dt>
61 <dt><span class="section"><a href="thread/thread_management.html#thread.thread_management.this_thread">Namespace <code class="computeroutput"><span class="identifier">this_thread</span></code></a></span></dt>
62 <dt><span class="section"><a href="thread/thread_management.html#thread.thread_management.threadgroup">Class <code class="computeroutput"><span class="identifier">thread_group</span></code> EXTENSION</a></span></dt>
63 </dl></dd>
64 <dt><span class="section"><a href="thread/ScopedThreads.html">Scoped Threads</a></span></dt>
65 <dd><dl>
66 <dt><span class="section"><a href="thread/ScopedThreads.html#thread.ScopedThreads.motivation">Motivation</a></span></dt>
67 <dt><span class="section"><a href="thread/ScopedThreads.html#thread.ScopedThreads.tutorial">Tutorial</a></span></dt>
68 <dt><span class="section"><a href="thread/ScopedThreads.html#thread.ScopedThreads.thread_functors">Free Thread Functors</a></span></dt>
69 <dt><span class="section"><a href="thread/ScopedThreads.html#thread.ScopedThreads.strict_scoped_thread">Class <code class="computeroutput"><span class="identifier">strict_scoped_thread</span></code></a></span></dt>
70 <dt><span class="section"><a href="thread/ScopedThreads.html#thread.ScopedThreads.scoped_thread">Class <code class="computeroutput"><span class="identifier">scoped_thread</span></code></a></span></dt>
71 <dt><span class="section"><a href="thread/ScopedThreads.html#thread.ScopedThreads.non_member_swap">Non-member function
72       <code class="computeroutput"><span class="identifier">swap</span><span class="special">(</span><span class="identifier">scoped_thread</span><span class="special">&amp;,</span><span class="identifier">scoped_thread</span><span class="special">&amp;)</span></code></a></span></dt>
73 </dl></dd>
74 <dt><span class="section"><a href="thread/synchronization.html">Synchronization</a></span></dt>
75 <dd><dl>
76 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.tutorial">Tutorial</a></span></dt>
77 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.mutex_concepts">Mutex Concepts</a></span></dt>
78 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.lock_option">Lock Options</a></span></dt>
79 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.lock_guard">Lock Guard</a></span></dt>
80 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.with_lock_guard">With Lock Guard</a></span></dt>
81 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.lock_concepts">Lock Concepts</a></span></dt>
82 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.locks">Lock Types</a></span></dt>
83 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.other_locks">Other Lock Types
84       - EXTENSION</a></span></dt>
85 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.lock_functions">Lock functions</a></span></dt>
86 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.lock_factories">Lock Factories
87       - EXTENSION</a></span></dt>
88 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.mutex_types">Mutex Types</a></span></dt>
89 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.condvar_ref">Condition Variables</a></span></dt>
90 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.once">One-time Initialization</a></span></dt>
91 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.barriers">Barriers -- EXTENSION</a></span></dt>
92 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.latches">Latches -- EXPERIMENTAL</a></span></dt>
93 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.executors">Executors and Schedulers
94       -- EXPERIMENTAL</a></span></dt>
95 <dt><span class="section"><a href="thread/synchronization.html#thread.synchronization.futures">Futures</a></span></dt>
96 </dl></dd>
97 <dt><span class="section"><a href="thread/thread_local_storage.html">Thread Local Storage</a></span></dt>
98 <dd><dl><dt><span class="section"><a href="thread/thread_local_storage.html#thread.thread_local_storage.thread_specific_ptr">Class
99       <code class="computeroutput"><span class="identifier">thread_specific_ptr</span></code></a></span></dt></dl></dd>
100 <dt><span class="section"><a href="thread/sds.html">Synchronized Data Structures</a></span></dt>
101 <dd><dl>
102 <dt><span class="section"><a href="thread/sds.html#thread.sds.synchronized_valuesxxx">Synchronized Values
103       - EXPERIMENTAL</a></span></dt>
104 <dt><span class="section"><a href="thread/sds.html#thread.sds.synchronized_queues">Synchronized Queues --
105       EXPERIMENTAL</a></span></dt>
106 </dl></dd>
107 <dt><span class="section"><a href="thread/parallel.html">Parallel - Fork-Join -- EXPERIMENTAL</a></span></dt>
108 <dd><dl>
109 <dt><span class="section"><a href="thread/parallel.html#thread.parallel.fork_join">Fork-Join</a></span></dt>
110 <dt><span class="section"><a href="thread/parallel.html#thread.parallel.ref">Reference -- EXPERIMENTAL</a></span></dt>
111 </dl></dd>
112 <dt><span class="section"><a href="thread/time.html">Time Requirements</a></span></dt>
113 <dd><dl><dt><span class="section"><a href="thread/time.html#thread.time.deprecated">Deprecated</a></span></dt></dl></dd>
114 <dt><span class="section"><a href="thread/emulations.html">Emulations</a></span></dt>
115 <dd><dl>
116 <dt><span class="section"><a href="thread/emulations.html#thread.emulations.delete"><code class="computeroutput"><span class="special">=</span><span class="keyword">delete</span></code> emulation</a></span></dt>
117 <dt><span class="section"><a href="thread/emulations.html#thread.emulations.move">Move semantics</a></span></dt>
118 <dt><span class="section"><a href="thread/emulations.html#thread.emulations.bool_explicit_conversion">Bool explicit
119       conversion</a></span></dt>
120 <dt><span class="section"><a href="thread/emulations.html#thread.emulations.scoped_enums">Scoped Enums</a></span></dt>
121 </dl></dd>
122 <dt><span class="section"><a href="thread/acknowledgements.html">Acknowledgments</a></span></dt>
123 <dt><span class="section"><a href="thread/compliance.html">Conformance and Extension</a></span></dt>
124 <dd><dl>
125 <dt><span class="section"><a href="thread/compliance.html#thread.compliance.cpp11">C++11 standard Thread library</a></span></dt>
126 <dt><span class="section"><a href="thread/compliance.html#thread.compliance.cxx14">C++14 standard Thread library
127       - accepted changes</a></span></dt>
128 <dt><span class="section"><a href="thread/compliance.html#thread.compliance.cxx1y">C++14 TS Extensions for Concurrency
129       V1 </a></span></dt>
130 <dt><span class="section"><a href="thread/compliance.html#thread.compliance.cxx1y0">C++1z TS Concurrency - On going
131       proposals</a></span></dt>
132 </dl></dd>
133 </dl>
134 </div>
135 <div class="section">
136 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
137 <a name="thread.overview"></a><a class="link" href="thread.html#thread.overview" title="Overview">Overview</a>
138 </h2></div></div></div>
139 <p>
140       <span class="bold"><strong>Boost.Thread</strong></span> enables the use of multiple threads
141       of execution with shared data in portable C++ code. It provides classes and
142       functions for managing the threads themselves, along with others for synchronizing
143       data between the threads or providing separate copies of data specific to individual
144       threads.
145     </p>
146 <p>
147       The <span class="bold"><strong>Boost.Thread</strong></span> library was originally written
148       and designed by William E. Kempf (version 1).
149     </p>
150 <p>
151       Anthony Williams version (version 2) was a major rewrite designed to closely
152       follow the proposals presented to the C++ Standards Committee, in particular
153       <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2497.html" target="_top">N2497</a>,
154       <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2320.html" target="_top">N2320</a>,
155       <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2184.html" target="_top">N2184</a>,
156       <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2139.html" target="_top">N2139</a>,
157       and <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2094.html" target="_top">N2094</a>
158     </p>
159 <p>
160       Vicente J. Botet Escriba started (version 3) the adaptation to comply with
161       the accepted Thread C++11 library (Make use of Boost.Chrono and Boost.Move)
162       and the <a href="http://home.roadrunner.com/~hinnant/bloomington/shared_mutex.html" target="_top">Shared
163       Locking</a> Howard Hinnant proposal except for the upward conversions.
164       Some minor non-standard features have been added also as thread attributes,
165       reverse_lock, shared_lock_guard.
166     </p>
167 <p>
168       In order to use the classes and functions described here, you can either include
169       the specific headers specified by the descriptions of each class or function,
170       or include the master thread library header:
171     </p>
172 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">thread</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
173 </pre>
174 <p>
175       which includes all the other headers in turn.
176     </p>
177 </div>
178 </div>
179 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
180 <td align="left"><p><small>Last revised: December 10, 2019 at 00:26:26 GMT</small></p></td>
181 <td align="right"><div class="copyright-footer"></div></td>
182 </tr></table>
183 <hr>
184 <div class="spirit-nav">
185 <a accesskey="p" href="boost_staticassert/test.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="libraries.html"><img src="../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="thread/build.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
186 </div>
187 </body>
188 </html>