119 lines
20 KiB
HTML
119 lines
20 KiB
HTML
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
|
|
<title>co_spawn</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="../reference.html" title="Reference">
|
||
|
|
<link rel="prev" href="cancellation_type_t.html" title="cancellation_type_t">
|
||
|
|
<link rel="next" href="co_spawn/overload1.html" title="co_spawn (1 of 6 overloads)">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
</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="cancellation_type_t.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="co_spawn/overload1.html"><img src="../../next.png" alt="Next"></a>
|
||
|
|
</div>
|
||
|
|
<div class="section">
|
||
|
|
<div class="titlepage"><div><div><h3 class="title">
|
||
|
|
<a name="asio.reference.co_spawn"></a><a class="link" href="co_spawn.html" title="co_spawn">co_spawn</a>
|
||
|
|
</h3></div></div></div>
|
||
|
|
<p>
|
||
|
|
<a class="indexterm" name="asio.indexterm.co_spawn"></a>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
Spawn a new coroutined-based thread of execution.
|
||
|
|
</p>
|
||
|
|
<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span>
|
||
|
|
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">Executor</a><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">T</span><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">AwaitableExecutor</a><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">CompletionToken</span> <span class="special">=</span> <a class="link" href="asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a><span class="special">></span>
|
||
|
|
<a class="link" href="asynchronous_operations.html#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><span class="special">(</span>
|
||
|
|
<span class="keyword">const</span> <span class="identifier">Executor</span> <span class="special">&</span> <span class="identifier">ex</span><span class="special">,</span>
|
||
|
|
<span class="identifier">awaitable</span><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">AwaitableExecutor</span> <span class="special">></span> <span class="identifier">a</span><span class="special">,</span>
|
||
|
|
<span class="identifier">CompletionToken</span> <span class="special">&&</span> <span class="identifier">token</span> <span class="special">=</span> <a class="link" href="asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">constraint</span><span class="special"><</span> <span class="special">(</span><span class="identifier">is_executor</span><span class="special"><</span> <span class="identifier">Executor</span> <span class="special">>::</span><span class="identifier">value</span><span class="special">||</span><span class="identifier">execution</span><span class="special">::</span><span class="identifier">is_executor</span><span class="special"><</span> <span class="identifier">Executor</span> <span class="special">>::</span><span class="identifier">value</span><span class="special">)&&</span><span class="identifier">is_convertible</span><span class="special"><</span> <span class="identifier">Executor</span><span class="special">,</span> <span class="identifier">AwaitableExecutor</span> <span class="special">>::</span><span class="identifier">value</span> <span class="special">>::</span><span class="identifier">type</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
|
||
|
|
<span class="emphasis"><em>» <a class="link" href="co_spawn/overload1.html" title="co_spawn (1 of 6 overloads)">more...</a></em></span>
|
||
|
|
|
||
|
|
<span class="keyword">template</span><span class="special"><</span>
|
||
|
|
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">Executor</a><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">AwaitableExecutor</a><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">CompletionToken</span> <span class="special">=</span> <a class="link" href="asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a><span class="special">></span>
|
||
|
|
<a class="link" href="asynchronous_operations.html#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><span class="special">(</span>
|
||
|
|
<span class="keyword">const</span> <span class="identifier">Executor</span> <span class="special">&</span> <span class="identifier">ex</span><span class="special">,</span>
|
||
|
|
<span class="identifier">awaitable</span><span class="special"><</span> <span class="keyword">void</span><span class="special">,</span> <span class="identifier">AwaitableExecutor</span> <span class="special">></span> <span class="identifier">a</span><span class="special">,</span>
|
||
|
|
<span class="identifier">CompletionToken</span> <span class="special">&&</span> <span class="identifier">token</span> <span class="special">=</span> <a class="link" href="asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">constraint</span><span class="special"><</span> <span class="special">(</span><span class="identifier">is_executor</span><span class="special"><</span> <span class="identifier">Executor</span> <span class="special">>::</span><span class="identifier">value</span><span class="special">||</span><span class="identifier">execution</span><span class="special">::</span><span class="identifier">is_executor</span><span class="special"><</span> <span class="identifier">Executor</span> <span class="special">>::</span><span class="identifier">value</span><span class="special">)&&</span><span class="identifier">is_convertible</span><span class="special"><</span> <span class="identifier">Executor</span><span class="special">,</span> <span class="identifier">AwaitableExecutor</span> <span class="special">>::</span><span class="identifier">value</span> <span class="special">>::</span><span class="identifier">type</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
|
||
|
|
<span class="emphasis"><em>» <a class="link" href="co_spawn/overload2.html" title="co_spawn (2 of 6 overloads)">more...</a></em></span>
|
||
|
|
|
||
|
|
<span class="keyword">template</span><span class="special"><</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">ExecutionContext</span><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">T</span><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">AwaitableExecutor</a><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">CompletionToken</span> <span class="special">=</span> <a class="link" href="asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a><span class="special">></span>
|
||
|
|
<a class="link" href="asynchronous_operations.html#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><span class="special">(</span>
|
||
|
|
<span class="identifier">ExecutionContext</span> <span class="special">&</span> <span class="identifier">ctx</span><span class="special">,</span>
|
||
|
|
<span class="identifier">awaitable</span><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">AwaitableExecutor</span> <span class="special">></span> <span class="identifier">a</span><span class="special">,</span>
|
||
|
|
<span class="identifier">CompletionToken</span> <span class="special">&&</span> <span class="identifier">token</span> <span class="special">=</span> <a class="link" href="asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">constraint</span><span class="special"><</span> <span class="identifier">is_convertible</span><span class="special"><</span> <span class="identifier">ExecutionContext</span> <span class="special">&,</span> <span class="identifier">execution_context</span> <span class="special">&</span> <span class="special">>::</span><span class="identifier">value</span> <span class="special">&&</span><span class="identifier">is_convertible</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">ExecutionContext</span><span class="special">::</span><span class="identifier">executor_type</span><span class="special">,</span> <span class="identifier">AwaitableExecutor</span> <span class="special">>::</span><span class="identifier">value</span> <span class="special">>::</span><span class="identifier">type</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
|
||
|
|
<span class="emphasis"><em>» <a class="link" href="co_spawn/overload3.html" title="co_spawn (3 of 6 overloads)">more...</a></em></span>
|
||
|
|
|
||
|
|
<span class="keyword">template</span><span class="special"><</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">ExecutionContext</span><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">AwaitableExecutor</a><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">CompletionToken</span> <span class="special">=</span> <a class="link" href="asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a><span class="special">></span>
|
||
|
|
<a class="link" href="asynchronous_operations.html#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><span class="special">(</span>
|
||
|
|
<span class="identifier">ExecutionContext</span> <span class="special">&</span> <span class="identifier">ctx</span><span class="special">,</span>
|
||
|
|
<span class="identifier">awaitable</span><span class="special"><</span> <span class="keyword">void</span><span class="special">,</span> <span class="identifier">AwaitableExecutor</span> <span class="special">></span> <span class="identifier">a</span><span class="special">,</span>
|
||
|
|
<span class="identifier">CompletionToken</span> <span class="special">&&</span> <span class="identifier">token</span> <span class="special">=</span> <a class="link" href="asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">constraint</span><span class="special"><</span> <span class="identifier">is_convertible</span><span class="special"><</span> <span class="identifier">ExecutionContext</span> <span class="special">&,</span> <span class="identifier">execution_context</span> <span class="special">&</span> <span class="special">>::</span><span class="identifier">value</span> <span class="special">&&</span><span class="identifier">is_convertible</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">ExecutionContext</span><span class="special">::</span><span class="identifier">executor_type</span><span class="special">,</span> <span class="identifier">AwaitableExecutor</span> <span class="special">>::</span><span class="identifier">value</span> <span class="special">>::</span><span class="identifier">type</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
|
||
|
|
<span class="emphasis"><em>» <a class="link" href="co_spawn/overload4.html" title="co_spawn (4 of 6 overloads)">more...</a></em></span>
|
||
|
|
|
||
|
|
<span class="keyword">template</span><span class="special"><</span>
|
||
|
|
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">Executor</a><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">F</span><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">CompletionToken</span> <span class="special">=</span> <a class="link" href="asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a><span class="special">></span>
|
||
|
|
<a class="link" href="asynchronous_operations.html#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><span class="special">(</span>
|
||
|
|
<span class="keyword">const</span> <span class="identifier">Executor</span> <span class="special">&</span> <span class="identifier">ex</span><span class="special">,</span>
|
||
|
|
<span class="identifier">F</span> <span class="special">&&</span> <span class="identifier">f</span><span class="special">,</span>
|
||
|
|
<span class="identifier">CompletionToken</span> <span class="special">&&</span> <span class="identifier">token</span> <span class="special">=</span> <a class="link" href="asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">constraint</span><span class="special"><</span> <span class="identifier">is_executor</span><span class="special"><</span> <span class="identifier">Executor</span> <span class="special">>::</span><span class="identifier">value</span><span class="special">||</span><span class="identifier">execution</span><span class="special">::</span><span class="identifier">is_executor</span><span class="special"><</span> <span class="identifier">Executor</span> <span class="special">>::</span><span class="identifier">value</span> <span class="special">>::</span><span class="identifier">type</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
|
||
|
|
<span class="emphasis"><em>» <a class="link" href="co_spawn/overload5.html" title="co_spawn (5 of 6 overloads)">more...</a></em></span>
|
||
|
|
|
||
|
|
<span class="keyword">template</span><span class="special"><</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">ExecutionContext</span><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">F</span><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">CompletionToken</span> <span class="special">=</span> <a class="link" href="asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a><span class="special">></span>
|
||
|
|
<a class="link" href="asynchronous_operations.html#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><span class="special">(</span>
|
||
|
|
<span class="identifier">ExecutionContext</span> <span class="special">&</span> <span class="identifier">ctx</span><span class="special">,</span>
|
||
|
|
<span class="identifier">F</span> <span class="special">&&</span> <span class="identifier">f</span><span class="special">,</span>
|
||
|
|
<span class="identifier">CompletionToken</span> <span class="special">&&</span> <span class="identifier">token</span> <span class="special">=</span> <a class="link" href="asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a><span class="special">,</span>
|
||
|
|
<span class="keyword">typename</span> <span class="identifier">constraint</span><span class="special"><</span> <span class="identifier">is_convertible</span><span class="special"><</span> <span class="identifier">ExecutionContext</span> <span class="special">&,</span> <span class="identifier">execution_context</span> <span class="special">&</span> <span class="special">>::</span><span class="identifier">value</span> <span class="special">>::</span><span class="identifier">type</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
|
||
|
|
<span class="emphasis"><em>» <a class="link" href="co_spawn/overload6.html" title="co_spawn (6 of 6 overloads)">more...</a></em></span>
|
||
|
|
</pre>
|
||
|
|
<h5>
|
||
|
|
<a name="asio.reference.co_spawn.h0"></a>
|
||
|
|
<span><a name="asio.reference.co_spawn.requirements"></a></span><a class="link" href="co_spawn.html#asio.reference.co_spawn.requirements">Requirements</a>
|
||
|
|
</h5>
|
||
|
|
<p>
|
||
|
|
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/co_spawn.hpp</code>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<div class="copyright-footer">Copyright © 2003-2023 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>
|
||
|
|
<hr>
|
||
|
|
<div class="spirit-nav">
|
||
|
|
<a accesskey="p" href="cancellation_type_t.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="co_spawn/overload1.html"><img src="../../next.png" alt="Next"></a>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|