• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>spawn (5 of 7 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="overload4.html" title="spawn (4 of 7 overloads)">
10<link rel="next" href="overload6.html" title="spawn (6 of 7 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="overload4.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="overload6.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.overload5"></a><a class="link" href="overload5.html" title="spawn (5 of 7 overloads)">spawn (5 of 7
28        overloads)</a>
29</h4></div></div></div>
30<p>
31          Start a new stackful coroutine that executes on a given strand.
32        </p>
33<pre class="programlisting">template&lt;
34    typename Function,
35    typename <a class="link" href="../Executor1.html" title="Executor requirements">Executor</a>&gt;
36void spawn(
37    const strand&lt; Executor &gt; &amp; ex,
38    Function &amp;&amp; function,
39    const boost::coroutines::attributes &amp; attributes = boost::coroutines::attributes());
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.overload5.h0"></a>
46          <span class="phrase"><a name="boost_asio.reference.spawn.overload5.parameters"></a></span><a class="link" href="overload5.html#boost_asio.reference.spawn.overload5.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">ex</span></dt>
52<dd><p>
53                Identifies the strand that will run the coroutine.
54              </p></dd>
55<dt><span class="term">function</span></dt>
56<dd>
57<p>
58                The coroutine function. The function must have the signature:
59</p>
60<pre class="programlisting">void function(yield_context yield);
61</pre>
62<p>
63              </p>
64</dd>
65<dt><span class="term">attributes</span></dt>
66<dd><p>
67                Boost.Coroutine attributes used to customise the coroutine.
68              </p></dd>
69</dl>
70</div>
71</div>
72<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
73<td align="left"></td>
74<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
75      Kohlhoff<p>
76        Distributed under the Boost Software License, Version 1.0. (See accompanying
77        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>)
78      </p>
79</div></td>
80</tr></table>
81<hr>
82<div class="spirit-nav">
83<a accesskey="p" href="overload4.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="overload6.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
84</div>
85</body>
86</html>
87