1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class symmetric_coroutine<>::yield_type</title> 5<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../index.html" title="Chapter 1. Coroutine"> 8<link rel="up" href="../symmetric.html" title="Symmetric coroutine"> 9<link rel="prev" href="symmetric_coro.html" title="Class symmetric_coroutine<>::call_type"> 10<link rel="next" href="../../attributes.html" title="Attributes"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="symmetric_coro.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../symmetric.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="../../attributes.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h4 class="title"> 27<a name="coroutine.coroutine.symmetric.yield_coro"></a><a class="link" href="yield_coro.html" title="Class symmetric_coroutine<>::yield_type">Class <code class="computeroutput"><span class="identifier">symmetric_coroutine</span><span class="special"><>::</span><span class="identifier">yield_type</span></code></a> 28</h4></div></div></div> 29<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">symmetric_coroutine</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 30 31<span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">R</span> <span class="special">></span> 32<span class="keyword">class</span> <span class="identifier">symmetric_coroutine</span><span class="special"><>::</span><span class="identifier">yield_type</span> 33<span class="special">{</span> 34<span class="keyword">public</span><span class="special">:</span> 35 <span class="identifier">yield_type</span><span class="special">()</span> <span class="keyword">noexcept</span><span class="special">;</span> 36 37 <span class="identifier">yield_type</span><span class="special">(</span> <span class="identifier">yield_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">other</span><span class="special">)=</span><span class="keyword">delete</span><span class="special">;</span> 38 39 <span class="identifier">yield_type</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">=(</span> <span class="identifier">yield_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">other</span><span class="special">)=</span><span class="keyword">delete</span><span class="special">;</span> 40 41 <span class="identifier">yield_type</span><span class="special">(</span> <span class="identifier">yield_type</span> <span class="special">&&</span> <span class="identifier">other</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 42 43 <span class="identifier">yield_type</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">=(</span> <span class="identifier">yield_type</span> <span class="special">&&</span> <span class="identifier">other</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 44 45 <span class="keyword">void</span> <span class="identifier">swap</span><span class="special">(</span> <span class="identifier">yield_type</span> <span class="special">&</span> <span class="identifier">other</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 46 47 <span class="keyword">operator</span> <span class="identifier">unspecified</span><span class="special">-</span><span class="keyword">bool</span><span class="special">-</span><span class="identifier">type</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> 48 49 <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!()</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 50 51 <span class="identifier">yield_type</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">()();</span> 52 53 <span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">X</span> <span class="special">></span> 54 <span class="identifier">yield_type</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">()(</span> <span class="identifier">symmetric_coroutine</span><span class="special"><</span> <span class="identifier">X</span> <span class="special">>::</span><span class="identifier">call_type</span> <span class="special">&</span> <span class="identifier">other</span><span class="special">,</span> <span class="identifier">X</span> <span class="special">&</span> <span class="identifier">x</span><span class="special">);</span> 55 56 <span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">X</span> <span class="special">></span> 57 <span class="identifier">yield_type</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">()(</span> <span class="identifier">symmetric_coroutine</span><span class="special"><</span> <span class="identifier">X</span> <span class="special">>::</span><span class="identifier">call_type</span> <span class="special">&</span> <span class="identifier">other</span><span class="special">);</span> 58 59 <span class="identifier">R</span> <span class="identifier">get</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> 60<span class="special">};</span> 61</pre> 62<h6> 63<a name="coroutine.coroutine.symmetric.yield_coro.h0"></a> 64 <span class="phrase"><a name="coroutine.coroutine.symmetric.yield_coro._code__phrase_role__keyword__operator__phrase___phrase_role__identifier__unspecified__phrase__phrase_role__special_____phrase__phrase_role__keyword__bool__phrase__phrase_role__special_____phrase__phrase_role__identifier__type__phrase__phrase_role__special______phrase___phrase_role__keyword__const__phrase___code_"></a></span><a class="link" href="yield_coro.html#coroutine.coroutine.symmetric.yield_coro._code__phrase_role__keyword__operator__phrase___phrase_role__identifier__unspecified__phrase__phrase_role__special_____phrase__phrase_role__keyword__bool__phrase__phrase_role__special_____phrase__phrase_role__identifier__type__phrase__phrase_role__special______phrase___phrase_role__keyword__const__phrase___code_"><code class="computeroutput"><span class="keyword">operator</span> <span class="identifier">unspecified</span><span class="special">-</span><span class="keyword">bool</span><span class="special">-</span><span class="identifier">type</span><span class="special">()</span> <span class="keyword">const</span></code></a> 65 </h6> 66<div class="variablelist"> 67<p class="title"><b></b></p> 68<dl class="variablelist"> 69<dt><span class="term">Returns:</span></dt> 70<dd><p> 71 If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> 72 refers to <span class="emphasis"><em>not-a-coroutine</em></span>, the function returns 73 <code class="computeroutput"><span class="keyword">false</span></code>. Otherwise <code class="computeroutput"><span class="keyword">true</span></code>. 74 </p></dd> 75<dt><span class="term">Throws:</span></dt> 76<dd><p> 77 Nothing. 78 </p></dd> 79</dl> 80</div> 81<h6> 82<a name="coroutine.coroutine.symmetric.yield_coro.h1"></a> 83 <span class="phrase"><a name="coroutine.coroutine.symmetric.yield_coro._code__phrase_role__keyword__bool__phrase___phrase_role__keyword__operator__phrase__phrase_role__special_______phrase___phrase_role__keyword__const__phrase___code_"></a></span><a class="link" href="yield_coro.html#coroutine.coroutine.symmetric.yield_coro._code__phrase_role__keyword__bool__phrase___phrase_role__keyword__operator__phrase__phrase_role__special_______phrase___phrase_role__keyword__const__phrase___code_"><code class="computeroutput"><span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!()</span> <span class="keyword">const</span></code></a> 84 </h6> 85<div class="variablelist"> 86<p class="title"><b></b></p> 87<dl class="variablelist"> 88<dt><span class="term">Returns:</span></dt> 89<dd><p> 90 If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> 91 refers to <span class="emphasis"><em>not-a-coroutine</em></span>, the function returns 92 <code class="computeroutput"><span class="keyword">true</span></code>. Otherwise <code class="computeroutput"><span class="keyword">false</span></code>. 93 </p></dd> 94<dt><span class="term">Throws:</span></dt> 95<dd><p> 96 Nothing. 97 </p></dd> 98</dl> 99</div> 100<h6> 101<a name="coroutine.coroutine.symmetric.yield_coro.h2"></a> 102 <span class="phrase"><a name="coroutine.coroutine.symmetric.yield_coro._code__phrase_role__identifier__yield_type__phrase___phrase_role__special___amp___phrase___phrase_role__keyword__operator__phrase__phrase_role__special________phrase___code_"></a></span><a class="link" href="yield_coro.html#coroutine.coroutine.symmetric.yield_coro._code__phrase_role__identifier__yield_type__phrase___phrase_role__special___amp___phrase___phrase_role__keyword__operator__phrase__phrase_role__special________phrase___code_"><code class="computeroutput"><span class="identifier">yield_type</span> <span class="special">&</span> 103 <span class="keyword">operator</span><span class="special">()()</span></code></a> 104 </h6> 105<pre class="programlisting"><span class="identifier">yield_type</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">()();</span> 106<span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">X</span> <span class="special">></span> 107<span class="identifier">yield_type</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">()(</span> <span class="identifier">symmetric_coroutine</span><span class="special"><</span> <span class="identifier">X</span> <span class="special">>::</span><span class="identifier">call_type</span> <span class="special">&</span> <span class="identifier">other</span><span class="special">,</span> <span class="identifier">X</span> <span class="special">&</span> <span class="identifier">x</span><span class="special">);</span> 108<span class="keyword">template</span><span class="special"><></span> 109<span class="identifier">yield_type</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">()(</span> <span class="identifier">symmetric_coroutine</span><span class="special"><</span> <span class="keyword">void</span> <span class="special">>::</span><span class="identifier">call_type</span> <span class="special">&</span> <span class="identifier">other</span><span class="special">);</span> 110</pre> 111<div class="variablelist"> 112<p class="title"><b></b></p> 113<dl class="variablelist"> 114<dt><span class="term">Preconditions:</span></dt> 115<dd><p> 116 <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> 117 is not a <span class="emphasis"><em>not-a-coroutine</em></span>. 118 </p></dd> 119<dt><span class="term">Effects:</span></dt> 120<dd><p> 121 The first function transfers execution control back to the starting 122 point, e.g. invocation of <span class="emphasis"><em>symmetric_coroutine<>::call_type::operator()</em></span>. 123 The last two functions transfer the execution control to another 124 symmetric coroutine. Parameter <code class="computeroutput"><span class="identifier">x</span></code> 125 is passed as value into <code class="computeroutput"><span class="identifier">other</span></code>'s 126 context. 127 </p></dd> 128<dt><span class="term">Throws:</span></dt> 129<dd><p> 130 <span class="emphasis"><em>detail::forced_unwind</em></span> 131 </p></dd> 132</dl> 133</div> 134<h6> 135<a name="coroutine.coroutine.symmetric.yield_coro.h3"></a> 136 <span class="phrase"><a name="coroutine.coroutine.symmetric.yield_coro._code__phrase_role__identifier__r__phrase___phrase_role__identifier__get__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="yield_coro.html#coroutine.coroutine.symmetric.yield_coro._code__phrase_role__identifier__r__phrase___phrase_role__identifier__get__phrase__phrase_role__special______phrase___code_"><code class="computeroutput"><span class="identifier">R</span> <span class="identifier">get</span><span class="special">()</span></code></a> 137 </h6> 138<pre class="programlisting"><span class="identifier">R</span> <span class="identifier">symmetric_coroutine</span><span class="special"><</span><span class="identifier">R</span><span class="special">>::</span><span class="identifier">yield_type</span><span class="special">::</span><span class="identifier">get</span><span class="special">();</span> 139<span class="identifier">R</span><span class="special">&</span> <span class="identifier">symmetric_coroutine</span><span class="special"><</span><span class="identifier">R</span><span class="special">&>::</span><span class="identifier">yield_type</span><span class="special">::</span><span class="identifier">get</span><span class="special">();</span> 140<span class="keyword">void</span> <span class="identifier">symmetric_coroutine</span><span class="special"><</span><span class="keyword">void</span><span class="special">></span><span class="identifier">yield_type</span><span class="special">::</span><span class="identifier">get</span><span class="special">()=</span><span class="keyword">delete</span><span class="special">;</span> 141</pre> 142<div class="variablelist"> 143<p class="title"><b></b></p> 144<dl class="variablelist"> 145<dt><span class="term">Preconditions:</span></dt> 146<dd><p> 147 <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> 148 is not a <span class="emphasis"><em>not-a-coroutine</em></span>. 149 </p></dd> 150<dt><span class="term">Returns:</span></dt> 151<dd><p> 152 Returns data transferred from coroutine-function via <span class="emphasis"><em>symmetric_coroutine<>::call_type::operator()</em></span>. 153 </p></dd> 154<dt><span class="term">Throws:</span></dt> 155<dd><p> 156 <code class="computeroutput"><span class="identifier">invalid_result</span></code> 157 </p></dd> 158</dl> 159</div> 160</div> 161<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 162<td align="left"></td> 163<td align="right"><div class="copyright-footer">Copyright © 2009 Oliver Kowalke<p> 164 Distributed under the Boost Software License, Version 1.0. (See accompanying 165 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>) 166 </p> 167</div></td> 168</tr></table> 169<hr> 170<div class="spirit-nav"> 171<a accesskey="p" href="symmetric_coro.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../symmetric.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="../../attributes.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 172</div> 173</body> 174</html> 175
