mirror of
https://github.com/boostorg/coroutine.git
synced 2026-01-30 19:52:18 +00:00
81 lines
4.6 KiB
HTML
81 lines
4.6 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>Overview</title>
|
|
<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
|
<link rel="home" href="../index.html" title="Chapter 1. Coroutine">
|
|
<link rel="up" href="../index.html" title="Chapter 1. Coroutine">
|
|
<link rel="prev" href="../index.html" title="Chapter 1. Coroutine">
|
|
<link rel="next" href="intro.html" title="Introduction">
|
|
</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="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="intro.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
|
|
<a name="coroutine.overview"></a><a class="link" href="overview.html" title="Overview">Overview</a>
|
|
</h2></div></div></div>
|
|
<p>
|
|
<span class="bold"><strong>Boost.Coroutine</strong></span> provides templates for generalized
|
|
subroutines which allow multiple entry points for suspending and resuming execution
|
|
at certain locations. It preserves the local state of execution and allows
|
|
re-entering subroutines more than once (useful if state must be kept across
|
|
function calls).
|
|
</p>
|
|
<p>
|
|
Coroutines can be viewed as a language-level construct providing a special
|
|
kind of control flow.
|
|
</p>
|
|
<p>
|
|
In contrast to threads, which are pre-emptive, <span class="emphasis"><em>coroutine</em></span>
|
|
switches are cooperative (programmer controls when a switch will happen). The
|
|
kernel is not involved in the coroutine switches.
|
|
</p>
|
|
<p>
|
|
The implementation uses <span class="bold"><strong>Boost.Context</strong></span> for
|
|
context switching.
|
|
</p>
|
|
<p>
|
|
This library is a follow-up on <a href="http://www.crystalclearsoftware.com/soc/coroutine/" target="_top">Boost.Coroutine</a>
|
|
by Giovanni P. Deretta.
|
|
</p>
|
|
<p>
|
|
In order to use the classes and functions described here, you can either include
|
|
the specific headers specified by the descriptions of each class or function,
|
|
or include the master library header:
|
|
</p>
|
|
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">coroutine</span><span class="special">/</span><span class="identifier">all</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
|
|
</pre>
|
|
<p>
|
|
which includes all the other headers in turn.
|
|
</p>
|
|
<p>
|
|
All functions and classes are contained in the namespace <span class="emphasis"><em>boost::coroutines</em></span>.
|
|
</p>
|
|
</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 © 2009 Oliver Kowalke<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="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="intro.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|