spawn.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>spawn</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="socket_base/_socket_base.html" title="socket_base::~socket_base">
  10. <link rel="next" href="spawn/overload1.html" title="spawn (1 of 4 overloads)">
  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="socket_base/_socket_base.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="spawn/overload1.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.spawn"></a><a class="link" href="spawn.html" title="spawn">spawn</a>
  21. </h3></div></div></div>
  22. <p>
  23. <a class="indexterm" name="idp156102416"></a>
  24. Start a new stackful coroutine.
  25. </p>
  26. <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  27. <span class="keyword">typename</span> <a class="link" href="Handler.html" title="Handlers">Handler</a><span class="special">,</span>
  28. <span class="keyword">typename</span> <span class="identifier">Function</span><span class="special">&gt;</span>
  29. <span class="keyword">void</span> <a class="link" href="spawn/overload1.html" title="spawn (1 of 4 overloads)">spawn</a><span class="special">(</span>
  30. <span class="identifier">Handler</span> <span class="identifier">handler</span><span class="special">,</span>
  31. <span class="identifier">Function</span> <span class="identifier">function</span><span class="special">,</span>
  32. <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">coroutines</span><span class="special">::</span><span class="identifier">attributes</span> <span class="special">&amp;</span> <span class="identifier">attributes</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">coroutines</span><span class="special">::</span><span class="identifier">attributes</span><span class="special">());</span>
  33. <span class="emphasis"><em>&#187; <a class="link" href="spawn/overload1.html" title="spawn (1 of 4 overloads)">more...</a></em></span>
  34. <span class="keyword">template</span><span class="special">&lt;</span>
  35. <span class="keyword">typename</span> <a class="link" href="Handler.html" title="Handlers">Handler</a><span class="special">,</span>
  36. <span class="keyword">typename</span> <span class="identifier">Function</span><span class="special">&gt;</span>
  37. <span class="keyword">void</span> <a class="link" href="spawn/overload2.html" title="spawn (2 of 4 overloads)">spawn</a><span class="special">(</span>
  38. <span class="identifier">basic_yield_context</span><span class="special">&lt;</span> <span class="identifier">Handler</span> <span class="special">&gt;</span> <span class="identifier">ctx</span><span class="special">,</span>
  39. <span class="identifier">Function</span> <span class="identifier">function</span><span class="special">,</span>
  40. <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">coroutines</span><span class="special">::</span><span class="identifier">attributes</span> <span class="special">&amp;</span> <span class="identifier">attributes</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">coroutines</span><span class="special">::</span><span class="identifier">attributes</span><span class="special">());</span>
  41. <span class="emphasis"><em>&#187; <a class="link" href="spawn/overload2.html" title="spawn (2 of 4 overloads)">more...</a></em></span>
  42. <span class="keyword">template</span><span class="special">&lt;</span>
  43. <span class="keyword">typename</span> <span class="identifier">Function</span><span class="special">&gt;</span>
  44. <span class="keyword">void</span> <a class="link" href="spawn/overload3.html" title="spawn (3 of 4 overloads)">spawn</a><span class="special">(</span>
  45. <span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">strand</span> <span class="identifier">strand</span><span class="special">,</span>
  46. <span class="identifier">Function</span> <span class="identifier">function</span><span class="special">,</span>
  47. <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">coroutines</span><span class="special">::</span><span class="identifier">attributes</span> <span class="special">&amp;</span> <span class="identifier">attributes</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">coroutines</span><span class="special">::</span><span class="identifier">attributes</span><span class="special">());</span>
  48. <span class="emphasis"><em>&#187; <a class="link" href="spawn/overload3.html" title="spawn (3 of 4 overloads)">more...</a></em></span>
  49. <span class="keyword">template</span><span class="special">&lt;</span>
  50. <span class="keyword">typename</span> <span class="identifier">Function</span><span class="special">&gt;</span>
  51. <span class="keyword">void</span> <a class="link" href="spawn/overload4.html" title="spawn (4 of 4 overloads)">spawn</a><span class="special">(</span>
  52. <span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&amp;</span> <span class="identifier">io_service</span><span class="special">,</span>
  53. <span class="identifier">Function</span> <span class="identifier">function</span><span class="special">,</span>
  54. <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">coroutines</span><span class="special">::</span><span class="identifier">attributes</span> <span class="special">&amp;</span> <span class="identifier">attributes</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">coroutines</span><span class="special">::</span><span class="identifier">attributes</span><span class="special">());</span>
  55. <span class="emphasis"><em>&#187; <a class="link" href="spawn/overload4.html" title="spawn (4 of 4 overloads)">more...</a></em></span>
  56. </pre>
  57. <p>
  58. The <code class="computeroutput"><span class="identifier">spawn</span><span class="special">()</span></code>
  59. function is a high-level wrapper over the Boost.Coroutine library. This function
  60. enables programs to implement asynchronous logic in a synchronous manner,
  61. as illustrated by the following example:
  62. </p>
  63. <pre class="programlisting"><span class="identifier">asio</span><span class="special">::</span><span class="identifier">spawn</span><span class="special">(</span><span class="identifier">my_strand</span><span class="special">,</span> <span class="identifier">do_echo</span><span class="special">);</span>
  64. <span class="comment">// ...</span>
  65. <span class="keyword">void</span> <span class="identifier">do_echo</span><span class="special">(</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">yield_context</span> <span class="identifier">yield</span><span class="special">)</span>
  66. <span class="special">{</span>
  67. <span class="keyword">try</span>
  68. <span class="special">{</span>
  69. <span class="keyword">char</span> <span class="identifier">data</span><span class="special">[</span><span class="number">128</span><span class="special">];</span>
  70. <span class="keyword">for</span> <span class="special">(;;)</span>
  71. <span class="special">{</span>
  72. <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">length</span> <span class="special">=</span>
  73. <span class="identifier">my_socket</span><span class="special">.</span><span class="identifier">async_read_some</span><span class="special">(</span>
  74. <span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">),</span> <span class="identifier">yield</span><span class="special">);</span>
  75. <span class="identifier">asio</span><span class="special">::</span><span class="identifier">async_write</span><span class="special">(</span><span class="identifier">my_socket</span><span class="special">,</span>
  76. <span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">length</span><span class="special">),</span> <span class="identifier">yield</span><span class="special">);</span>
  77. <span class="special">}</span>
  78. <span class="special">}</span>
  79. <span class="keyword">catch</span> <span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">exception</span><span class="special">&amp;</span> <span class="identifier">e</span><span class="special">)</span>
  80. <span class="special">{</span>
  81. <span class="comment">// ...</span>
  82. <span class="special">}</span>
  83. <span class="special">}</span>
  84. </pre>
  85. <h5>
  86. <a name="asio.reference.spawn.h0"></a>
  87. <span><a name="asio.reference.spawn.requirements"></a></span><a class="link" href="spawn.html#asio.reference.spawn.requirements">Requirements</a>
  88. </h5>
  89. <p>
  90. <span class="emphasis"><em>Header: </em></span><code class="literal">asio/spawn.hpp</code>
  91. </p>
  92. <p>
  93. <span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
  94. </p>
  95. </div>
  96. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  97. <td align="left"></td>
  98. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  99. Distributed under the Boost Software License, Version 1.0. (See accompanying
  100. 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>)
  101. </p>
  102. </div></td>
  103. </tr></table>
  104. <hr>
  105. <div class="spirit-nav">
  106. <a accesskey="p" href="socket_base/_socket_base.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="spawn/overload1.html"><img src="../../next.png" alt="Next"></a>
  107. </div>
  108. </body>
  109. </html>