Insane_DNS/libraries/asio-1.28.1/doc/asio/reference/spawn/overload12.html

76 lines
4.8 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>spawn (12 of 13 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="../spawn.html" title="spawn">
<link rel="prev" href="overload11.html" title="spawn (11 of 13 overloads)">
<link rel="next" href="overload13.html" title="spawn (13 of 13 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="overload11.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../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="overload13.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.spawn.overload12"></a><a class="link" href="overload12.html" title="spawn (12 of 13 overloads)">spawn (12 of 13 overloads)</a>
</h4></div></div></div>
<p>
(Deprecated: Use overloads with a completion token.) Start a new stackful
coroutine that executes in the context of a strand.
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">Function</span><span class="special">&gt;</span>
<span class="keyword">void</span> <span class="identifier">spawn</span><span class="special">(</span>
<span class="keyword">const</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_context</span><span class="special">::</span><span class="identifier">strand</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
<span class="identifier">Function</span> <span class="special">&amp;&amp;</span> <span class="identifier">function</span><span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">coroutines</span><span class="special">::</span><span class="identifier">attributes</span> <span class="special">&amp;</span> <span class="identifier">attributes</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">coroutines</span><span class="special">::</span><span class="identifier">attributes</span><span class="special">());</span>
</pre>
<p>
This function is used to launch a new coroutine.
</p>
<h6>
<a name="asio.reference.spawn.overload12.h0"></a>
<span><a name="asio.reference.spawn.overload12.parameters"></a></span><a class="link" href="overload12.html#asio.reference.spawn.overload12.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">s</span></dt>
<dd><p>
Identifies a strand. By starting multiple coroutines on the same
strand, the implementation ensures that none of those coroutines
can execute simultaneously.
</p></dd>
<dt><span class="term">function</span></dt>
<dd>
<p>
The coroutine function. The function must have the signature:
</p>
<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">function</span><span class="special">(</span><span class="identifier">yield_context</span> <span class="identifier">yield</span><span class="special">);</span>
</pre>
</dd>
<dt><span class="term">attributes</span></dt>
<dd><p>
Boost.Coroutine attributes used to customise the coroutine.
</p></dd>
</dl>
</div>
</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="overload11.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../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="overload13.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>