| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>spawn (1 of 4 overloads)</title> |
| <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> |
| <link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> |
| <link rel="up" href="../spawn.html" title="spawn"> |
| <link rel="prev" href="../spawn.html" title="spawn"> |
| <link rel="next" href="overload2.html" title="spawn (2 of 4 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="../spawn.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../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="overload2.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.spawn.overload1"></a><a class="link" href="overload1.html" title="spawn (1 of 4 overloads)">spawn (1 of 4 |
| overloads)</a> |
| </h4></div></div></div> |
| <p> |
| Start a new stackful coroutine, calling the specified handler when it completes. |
| </p> |
| <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> |
| <span class="keyword">typename</span> <a class="link" href="../Handler.html" title="Handlers">Handler</a><span class="special">,</span> |
| <span class="keyword">typename</span> <span class="identifier">Function</span><span class="special">></span> |
| <span class="keyword">void</span> <span class="identifier">spawn</span><span class="special">(</span> |
| <span class="identifier">Handler</span> <span class="identifier">handler</span><span class="special">,</span> |
| <span class="identifier">Function</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">&</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="boost_asio.reference.spawn.overload1.h0"></a> |
| <span class="phrase"><a name="boost_asio.reference.spawn.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.spawn.overload1.parameters">Parameters</a> |
| </h6> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl class="variablelist"> |
| <dt><span class="term">handler</span></dt> |
| <dd> |
| <p> |
| A handler to be called when the coroutine exits. More importantly, |
| the handler provides an execution context (via the the handler invocation |
| hook) for the coroutine. The handler must have the signature: |
| </p> |
| <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">();</span> |
| </pre> |
| <p> |
| </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">basic_yield_context</span><span class="special"><</span><span class="identifier">Handler</span><span class="special">></span> <span class="identifier">yield</span><span class="special">);</span> |
| </pre> |
| <p> |
| </p> |
| </dd> |
| <dt><span class="term">attributes</span></dt> |
| <dd><p> |
| Boost.Coroutine attributes used to customise the coroutine. |
| </p></dd> |
| </dl> |
| </div> |
| </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-2015 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="../spawn.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../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="overload2.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
