overload2.html 5.34 KB

Edit Raw Blame History

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>co_spawn (2 of 6 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="../co_spawn.html" title="co_spawn">
<link rel="prev" href="overload1.html" title="co_spawn (1 of 6 overloads)">
<link rel="next" href="overload3.html" title="co_spawn (3 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="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../co_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="overload3.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.co_spawn.overload2"></a><a class="link" href="overload2.html" title="co_spawn (2 of 6 overloads)">co_spawn (2 of 6
        overloads)</a>
</h4></div></div></div>
<p>
          Spawn a new coroutined-based thread of execution.
        </p>
<pre class="programlisting">template&lt;
    typename <a class="link" href="../Executor1.html" title="Executor requirements">Executor</a>,
    typename <a class="link" href="../Executor1.html" title="Executor requirements">AwaitableExecutor</a>,
    typename CompletionToken = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
<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> co_spawn(
    const Executor &amp; ex,
    awaitable&lt; void, AwaitableExecutor &gt; a,
    CompletionToken &amp;&amp; token = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>,
    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);
</pre>
<h6>
<a name="asio.reference.co_spawn.overload2.h0"></a>
          <span><a name="asio.reference.co_spawn.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.co_spawn.overload2.parameters">Parameters</a>
        </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">ex</span></dt>
<dd><p>
                The executor that will 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="asio.reference.co_spawn.overload2.h1"></a>
          <span><a name="asio.reference.co_spawn.overload2.example"></a></span><a class="link" href="overload2.html#asio.reference.co_spawn.overload2.example">Example</a>
        </h6>
<pre class="programlisting">asio::awaitable&lt;void&gt; echo(tcp::socket socket)
{
  try
  {
    char data[1024];
    for (;;)
    {
      std::size_t n = co_await socket.async_read_some(
          asio::buffer(data), asio::use_awaitable);

      co_await asio::async_write(socket,
          asio::buffer(data, n), asio::use_awaitable);
    }
  }
  catch (const std::exception&amp; e)
  {
    std::cerr &lt;&lt; "Exception: " &lt;&lt; e.what() &lt;&lt; "\n";
  }
}

// ...

asio::co_spawn(my_executor,
  echo(std::move(my_tcp_socket)),
  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-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="overload1.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../co_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="overload3.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>