doc/html/boost_asio/reference/spawn/overload2.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>spawn (2 of 4 overloads)</title>
   5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
   8 <link rel="up" href="../spawn.html" title="spawn">
   9 <link rel="prev" href="overload1.html" title="spawn (1 of 4 overloads)">
  10 <link rel="next" href="overload3.html" title="spawn (3 of 4 overloads)">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="overload1.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../spawn.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="boost_asio.reference.spawn.overload2"></a><a class="link" href="overload2.html" title="spawn (2 of 4 overloads)">spawn (2 of 4
  28         overloads)</a>
  29 </h4></div></div></div>
  30 <p>
  31           Start a new stackful coroutine, inheriting the execution context of another.
  32         </p>
  33 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  34     <span class="keyword">typename</span> <a class="link" href="../Handler.html" title="Handlers">Handler</a><span class="special">,</span>
  35     <span class="keyword">typename</span> <span class="identifier">Function</span><span class="special">&gt;</span>
  36 <span class="keyword">void</span> <span class="identifier">spawn</span><span class="special">(</span>
  37     <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>
  38     <span class="identifier">Function</span> <span class="identifier">function</span><span class="special">,</span>
  39     <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>
  40 </pre>
  41 <p>
  42           This function is used to launch a new coroutine.
  43         </p>
  44 <h6>
  45 <a name="boost_asio.reference.spawn.overload2.h0"></a>
  46           <span class="phrase"><a name="boost_asio.reference.spawn.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.spawn.overload2.parameters">Parameters</a>
  47         </h6>
  48 <div class="variablelist">
  49 <p class="title"><b></b></p>
  50 <dl class="variablelist">
  51 <dt><span class="term">ctx</span></dt>
  52 <dd><p>
  53                 Identifies the current coroutine as a parent of the new coroutine.
  54                 This specifies that the new coroutine should inherit the execution
  55                 context of the parent. For example, if the parent coroutine is executing
  56                 in a particular strand, then the new coroutine will execute in the
  57                 same strand.
  58               </p></dd>
  59 <dt><span class="term">function</span></dt>
  60 <dd>
  61 <p>
  62                 The coroutine function. The function must have the signature:
  63 </p>
  64 <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">function</span><span class="special">(</span><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">yield</span><span class="special">);</span>
  65 </pre>
  66 <p>
  67               </p>
  68 </dd>
  69 <dt><span class="term">attributes</span></dt>
  70 <dd><p>
  71                 Boost.Coroutine attributes used to customise the coroutine.
  72               </p></dd>
  73 </dl>
  74 </div>
  75 </div>
  76 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  77 <td align="left"></td>
  78 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
  79         Distributed under the Boost Software License, Version 1.0. (See accompanying
  80         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>)
  81       </p>
  82 </div></td>
  83 </tr></table>
  84 <hr>
  85 <div class="spirit-nav">
  86 <a accesskey="p" href="overload1.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../spawn.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  87 </div>
  88 </body>
  89 </html>