overload6.html 3.57 KB
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>spawn (6 of 7 overloads)</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="../spawn.html" title="spawn">
<link rel="prev" href="overload5.html" title="spawn (5 of 7 overloads)">
<link rel="next" href="overload7.html" title="spawn (7 of 7 overloads)">
</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="overload5.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../spawn.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="overload7.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.spawn.overload6"></a><a class="link" href="overload6.html" title="spawn (6 of 7 overloads)">spawn (6 of 7 overloads)</a>
</h4></div></div></div>
<p>
          Start a new stackful coroutine that executes in the context of a strand.
        </p>
<pre class="programlisting">template&lt;
    typename Function&gt;
void spawn(
    const asio::io_context::strand &amp; s,
    Function &amp;&amp; function,
    const boost::coroutines::attributes &amp; attributes = boost::coroutines::attributes());
</pre>
<p>
          This function is used to launch a new coroutine.
        </p>
<h6>
<a name="asio.reference.spawn.overload6.h0"></a>
          <span><a name="asio.reference.spawn.overload6.parameters"></a></span><a class="link" href="overload6.html#asio.reference.spawn.overload6.parameters">Parameters</a>
        </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">s</span></dt>
<dd><p>
                Identifies a strand. By starting multiple coroutines on the same
                strand, the implementation ensures that none of those coroutines
                can execute simultaneously.
              </p></dd>
<dt><span class="term">function</span></dt>
<dd>
<p>
                The coroutine function. The function must have the signature:
</p>
<pre class="programlisting">void function(yield_context yield);
</pre>
<p>
              </p>
</dd>
<dt><span class="term">attributes</span></dt>
<dd><p>
                Boost.Coroutine attributes used to customise the coroutine.
              </p></dd>
</dl>
</div>
</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="overload5.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../spawn.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="overload7.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>