121 lines
6.1 KiB
HTML
121 lines
6.1 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>co_spawn (4 of 6 overloads)</title>
|
|
<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
|
|
<link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
|
|
<link rel="up" href="../co_spawn.html" title="co_spawn">
|
|
<link rel="prev" href="overload3.html" title="co_spawn (3 of 6 overloads)">
|
|
<link rel="next" href="overload5.html" title="co_spawn (5 of 6 overloads)">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<table cellpadding="2" width="100%"><tr>
|
|
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
|
|
<td align="center"><a href="../../../../../index.html">Home</a></td>
|
|
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
|
|
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
|
|
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
|
|
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
|
|
</tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../co_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="overload5.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="boost_asio.reference.co_spawn.overload4"></a><a class="link" href="overload4.html" title="co_spawn (4 of 6 overloads)">co_spawn (4
|
|
of 6 overloads)</a>
|
|
</h4></div></div></div>
|
|
<p>
|
|
Spawn a new coroutined-based thread of execution.
|
|
</p>
|
|
<pre class="programlisting">template<
|
|
typename ExecutionContext,
|
|
typename <a class="link" href="../Executor1.html" title="Executor requirements">AwaitableExecutor</a>,
|
|
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>>
|
|
<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> co_spawn(
|
|
ExecutionContext & ctx,
|
|
awaitable< void, AwaitableExecutor > a,
|
|
CompletionToken && token = <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>,
|
|
typename constraint< is_convertible< ExecutionContext &, execution_context & >::value &&is_convertible< typename ExecutionContext::executor_type, AwaitableExecutor >::value >::type = 0);
|
|
</pre>
|
|
<h6>
|
|
<a name="boost_asio.reference.co_spawn.overload4.h0"></a>
|
|
<span class="phrase"><a name="boost_asio.reference.co_spawn.overload4.parameters"></a></span><a class="link" href="overload4.html#boost_asio.reference.co_spawn.overload4.parameters">Parameters</a>
|
|
</h6>
|
|
<div class="variablelist">
|
|
<p class="title"><b></b></p>
|
|
<dl class="variablelist">
|
|
<dt><span class="term">ctx</span></dt>
|
|
<dd><p>
|
|
An execution context that will provide the executor to be used to
|
|
schedule the new thread of execution.
|
|
</p></dd>
|
|
<dt><span class="term">a</span></dt>
|
|
<dd><p>
|
|
The <a class="link" href="../awaitable.html" title="awaitable"><code class="computeroutput">awaitable</code></a>
|
|
object that is the result of calling the coroutine's entry point
|
|
function.
|
|
</p></dd>
|
|
<dt><span class="term">token</span></dt>
|
|
<dd>
|
|
<p>
|
|
The completion token that will handle the notification that the thread
|
|
of execution has completed. The function signature of the completion
|
|
handler must be:
|
|
</p>
|
|
<pre class="programlisting">void handler(std::exception_ptr);
|
|
</pre>
|
|
<p>
|
|
</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h6>
|
|
<a name="boost_asio.reference.co_spawn.overload4.h1"></a>
|
|
<span class="phrase"><a name="boost_asio.reference.co_spawn.overload4.example"></a></span><a class="link" href="overload4.html#boost_asio.reference.co_spawn.overload4.example">Example</a>
|
|
</h6>
|
|
<pre class="programlisting">boost::asio::awaitable<void> echo(tcp::socket socket)
|
|
{
|
|
try
|
|
{
|
|
char data[1024];
|
|
for (;;)
|
|
{
|
|
std::size_t n = co_await socket.async_read_some(
|
|
boost::asio::buffer(data), boost::asio::use_awaitable);
|
|
|
|
co_await boost::asio::async_write(socket,
|
|
boost::asio::buffer(data, n), boost::asio::use_awaitable);
|
|
}
|
|
}
|
|
catch (const std::exception& e)
|
|
{
|
|
std::cerr << "Exception: " << e.what() << "\n";
|
|
}
|
|
}
|
|
|
|
// ...
|
|
|
|
boost::asio::co_spawn(my_io_context,
|
|
echo(std::move(my_tcp_socket)),
|
|
boost::asio::detached);
|
|
</pre>
|
|
</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-2021 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="overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../co_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="overload5.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|