• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>co_spawn</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="../reference.html" title="Reference">
9<link rel="prev" href="can_require_concept.html" title="can_require_concept">
10<link rel="next" href="co_spawn/overload1.html" title="co_spawn (1 of 6 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="can_require_concept.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="co_spawn/overload1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h3 class="title">
27<a name="boost_asio.reference.co_spawn"></a><a class="link" href="co_spawn.html" title="co_spawn">co_spawn</a>
28</h3></div></div></div>
29<p>
30        <a class="indexterm" name="boost_asio.indexterm.co_spawn"></a>
31Spawn a new coroutined-based thread
32        of execution.
33      </p>
34<pre class="programlisting">template&lt;
35    typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>,
36    typename T,
37    typename <a class="link" href="Executor1.html" title="Executor requirements">AwaitableExecutor</a>,
38    typename CompletionToken = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
39<a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <a class="link" href="co_spawn/overload1.html" title="co_spawn (1 of 6 overloads)">co_spawn</a>(
40    const Executor &amp; ex,
41    awaitable&lt; T, AwaitableExecutor &gt; a,
42    CompletionToken &amp;&amp; token = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>,
43    typename enable_if&lt; (is_executor&lt; Executor &gt;::value||execution::is_executor&lt; Executor &gt;::value)&amp;&amp;is_convertible&lt; Executor, AwaitableExecutor &gt;::value &gt;::type *  = 0);
44  <span class="emphasis"><em>» <a class="link" href="co_spawn/overload1.html" title="co_spawn (1 of 6 overloads)">more...</a></em></span>
45
46template&lt;
47    typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>,
48    typename <a class="link" href="Executor1.html" title="Executor requirements">AwaitableExecutor</a>,
49    typename CompletionToken = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
50<a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <a class="link" href="co_spawn/overload2.html" title="co_spawn (2 of 6 overloads)">co_spawn</a>(
51    const Executor &amp; ex,
52    awaitable&lt; void, AwaitableExecutor &gt; a,
53    CompletionToken &amp;&amp; token = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>,
54    typename enable_if&lt; (is_executor&lt; Executor &gt;::value||execution::is_executor&lt; Executor &gt;::value)&amp;&amp;is_convertible&lt; Executor, AwaitableExecutor &gt;::value &gt;::type *  = 0);
55  <span class="emphasis"><em>» <a class="link" href="co_spawn/overload2.html" title="co_spawn (2 of 6 overloads)">more...</a></em></span>
56
57template&lt;
58    typename ExecutionContext,
59    typename T,
60    typename <a class="link" href="Executor1.html" title="Executor requirements">AwaitableExecutor</a>,
61    typename CompletionToken = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
62<a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <a class="link" href="co_spawn/overload3.html" title="co_spawn (3 of 6 overloads)">co_spawn</a>(
63    ExecutionContext &amp; ctx,
64    awaitable&lt; T, AwaitableExecutor &gt; a,
65    CompletionToken &amp;&amp; token = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>,
66    typename enable_if&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value &amp;&amp;is_convertible&lt; typename ExecutionContext::executor_type, AwaitableExecutor &gt;::value &gt;::type *  = 0);
67  <span class="emphasis"><em>» <a class="link" href="co_spawn/overload3.html" title="co_spawn (3 of 6 overloads)">more...</a></em></span>
68
69template&lt;
70    typename ExecutionContext,
71    typename <a class="link" href="Executor1.html" title="Executor requirements">AwaitableExecutor</a>,
72    typename CompletionToken = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
73<a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <a class="link" href="co_spawn/overload4.html" title="co_spawn (4 of 6 overloads)">co_spawn</a>(
74    ExecutionContext &amp; ctx,
75    awaitable&lt; void, AwaitableExecutor &gt; a,
76    CompletionToken &amp;&amp; token = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>,
77    typename enable_if&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value &amp;&amp;is_convertible&lt; typename ExecutionContext::executor_type, AwaitableExecutor &gt;::value &gt;::type *  = 0);
78  <span class="emphasis"><em>» <a class="link" href="co_spawn/overload4.html" title="co_spawn (4 of 6 overloads)">more...</a></em></span>
79
80template&lt;
81    typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>,
82    typename F,
83    typename CompletionToken = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
84<a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <a class="link" href="co_spawn/overload5.html" title="co_spawn (5 of 6 overloads)">co_spawn</a>(
85    const Executor &amp; ex,
86    F &amp;&amp; f,
87    CompletionToken &amp;&amp; token = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>,
88    typename enable_if&lt; is_executor&lt; Executor &gt;::value||execution::is_executor&lt; Executor &gt;::value &gt;::type *  = 0);
89  <span class="emphasis"><em>» <a class="link" href="co_spawn/overload5.html" title="co_spawn (5 of 6 overloads)">more...</a></em></span>
90
91template&lt;
92    typename ExecutionContext,
93    typename F,
94    typename CompletionToken = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
95<a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <a class="link" href="co_spawn/overload6.html" title="co_spawn (6 of 6 overloads)">co_spawn</a>(
96    ExecutionContext &amp; ctx,
97    F &amp;&amp; f,
98    CompletionToken &amp;&amp; token = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>,
99    typename enable_if&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value &gt;::type *  = 0);
100  <span class="emphasis"><em>» <a class="link" href="co_spawn/overload6.html" title="co_spawn (6 of 6 overloads)">more...</a></em></span>
101</pre>
102<h5>
103<a name="boost_asio.reference.co_spawn.h0"></a>
104        <span class="phrase"><a name="boost_asio.reference.co_spawn.requirements"></a></span><a class="link" href="co_spawn.html#boost_asio.reference.co_spawn.requirements">Requirements</a>
105      </h5>
106<p>
107        <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/co_spawn.hpp</code>
108      </p>
109<p>
110        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
111      </p>
112</div>
113<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
114<td align="left"></td>
115<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
116      Kohlhoff<p>
117        Distributed under the Boost Software License, Version 1.0. (See accompanying
118        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>)
119      </p>
120</div></td>
121</tr></table>
122<hr>
123<div class="spirit-nav">
124<a accesskey="p" href="can_require_concept.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="co_spawn/overload1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
125</div>
126</body>
127</html>
128