thread.html 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>thread</title>
  5. <link rel="stylesheet" href="../../boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
  7. <link rel="home" href="../../index.html" title="Asio">
  8. <link rel="up" href="../reference.html" title="Reference">
  9. <link rel="prev" href="system_timer.html" title="system_timer">
  10. <link rel="next" href="thread/join.html" title="thread::join">
  11. </head>
  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13. <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
  14. <hr>
  15. <div class="spirit-nav">
  16. <a accesskey="p" href="system_timer.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>
  17. </div>
  18. <div class="section">
  19. <div class="titlepage"><div><div><h3 class="title">
  20. <a name="asio.reference.thread"></a><a class="link" href="thread.html" title="thread">thread</a>
  21. </h3></div></div></div>
  22. <p>
  23. A simple abstraction for starting threads.
  24. </p>
  25. <pre class="programlisting"><span class="keyword">class</span> <span class="identifier">thread</span> <span class="special">:</span>
  26. <span class="identifier">noncopyable</span>
  27. </pre>
  28. <h5>
  29. <a name="asio.reference.thread.h0"></a>
  30. <span><a name="asio.reference.thread.member_functions"></a></span><a class="link" href="thread.html#asio.reference.thread.member_functions">Member
  31. Functions</a>
  32. </h5>
  33. <div class="informaltable"><table class="table">
  34. <colgroup>
  35. <col>
  36. <col>
  37. </colgroup>
  38. <thead><tr>
  39. <th>
  40. <p>
  41. Name
  42. </p>
  43. </th>
  44. <th>
  45. <p>
  46. Description
  47. </p>
  48. </th>
  49. </tr></thead>
  50. <tbody>
  51. <tr>
  52. <td>
  53. <p>
  54. <a class="link" href="thread/join.html" title="thread::join"><span class="bold"><strong>join</strong></span></a>
  55. </p>
  56. </td>
  57. <td>
  58. <p>
  59. Wait for the thread to exit.
  60. </p>
  61. </td>
  62. </tr>
  63. <tr>
  64. <td>
  65. <p>
  66. <a class="link" href="thread/thread.html" title="thread::thread"><span class="bold"><strong>thread</strong></span></a>
  67. </p>
  68. </td>
  69. <td>
  70. <p>
  71. Start a new thread that executes the supplied function.
  72. </p>
  73. </td>
  74. </tr>
  75. <tr>
  76. <td>
  77. <p>
  78. <a class="link" href="thread/_thread.html" title="thread::~thread"><span class="bold"><strong>~thread</strong></span></a>
  79. </p>
  80. </td>
  81. <td>
  82. <p>
  83. Destructor.
  84. </p>
  85. </td>
  86. </tr>
  87. </tbody>
  88. </table></div>
  89. <p>
  90. The <a class="link" href="thread.html" title="thread"><code class="computeroutput"><span class="identifier">thread</span></code></a>
  91. class implements the smallest possible subset of the functionality of boost::thread.
  92. It is intended to be used only for starting a thread and waiting for it to
  93. exit. If more extensive threading capabilities are required, you are strongly
  94. advised to use something else.
  95. </p>
  96. <h5>
  97. <a name="asio.reference.thread.h1"></a>
  98. <span><a name="asio.reference.thread.thread_safety"></a></span><a class="link" href="thread.html#asio.reference.thread.thread_safety">Thread
  99. Safety</a>
  100. </h5>
  101. <p>
  102. <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
  103. </p>
  104. <p>
  105. <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
  106. </p>
  107. <h5>
  108. <a name="asio.reference.thread.h2"></a>
  109. <span><a name="asio.reference.thread.example"></a></span><a class="link" href="thread.html#asio.reference.thread.example">Example</a>
  110. </h5>
  111. <p>
  112. A typical use of <a class="link" href="thread.html" title="thread"><code class="computeroutput"><span class="identifier">thread</span></code></a>
  113. would be to launch a thread to run an io_service's event processing loop:
  114. </p>
  115. <pre class="programlisting"><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="identifier">io_service</span><span class="special">;</span>
  116. <span class="comment">// ...</span>
  117. <span class="identifier">asio</span><span class="special">::</span><span class="identifier">thread</span> <span class="identifier">t</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">bind</span><span class="special">(&amp;</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">run</span><span class="special">,</span> <span class="special">&amp;</span><span class="identifier">io_service</span><span class="special">));</span>
  118. <span class="comment">// ...</span>
  119. <span class="identifier">t</span><span class="special">.</span><span class="identifier">join</span><span class="special">();</span>
  120. </pre>
  121. <h5>
  122. <a name="asio.reference.thread.h3"></a>
  123. <span><a name="asio.reference.thread.requirements"></a></span><a class="link" href="thread.html#asio.reference.thread.requirements">Requirements</a>
  124. </h5>
  125. <p>
  126. <span class="emphasis"><em>Header: </em></span><code class="literal">asio/thread.hpp</code>
  127. </p>
  128. <p>
  129. <span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
  130. </p>
  131. </div>
  132. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  133. <td align="left"></td>
  134. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  135. Distributed under the Boost Software License, Version 1.0. (See accompanying
  136. 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>)
  137. </p>
  138. </div></td>
  139. </tr></table>
  140. <hr>
  141. <div class="spirit-nav">
  142. <a accesskey="p" href="system_timer.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>
  143. </div>
  144. </body>
  145. </html>