| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>Class asymmetric_coroutine<>::pull_type</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="../../../index.html" title="Chapter 1. Coroutine"> |
| <link rel="up" href="../asymmetric.html" title="Asymmetric coroutine"> |
| <link rel="prev" href="../asymmetric.html" title="Asymmetric coroutine"> |
| <link rel="next" href="push_coro.html" title="Class asymmetric_coroutine<>::push_type"> |
| </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="../asymmetric.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../asymmetric.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="push_coro.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="coroutine.coroutine.asymmetric.pull_coro"></a><a class="link" href="pull_coro.html" title="Class asymmetric_coroutine<>::pull_type">Class <code class="computeroutput"><span class="identifier">asymmetric_coroutine</span><span class="special"><>::</span><span class="identifier">pull_type</span></code></a> |
| </h4></div></div></div> |
| <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">asymmetric_coroutine</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> |
| |
| <span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">R</span> <span class="special">></span> |
| <span class="keyword">class</span> <span class="identifier">asymmetric_coroutine</span><span class="special"><>::</span><span class="identifier">pull_type</span> |
| <span class="special">{</span> |
| <span class="keyword">public</span><span class="special">:</span> |
| <span class="identifier">pull_type</span><span class="special">()</span> <span class="keyword">noexcept</span><span class="special">;</span> |
| |
| <span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Fn</span> <span class="special">></span> |
| <span class="identifier">pull_type</span><span class="special">(</span> <span class="identifier">Fn</span> <span class="special">&&</span> <span class="identifier">fn</span><span class="special">,</span> <span class="identifier">attributes</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">attr</span> <span class="special">=</span> <span class="identifier">attributes</span><span class="special">()</span> <span class="special">);</span> |
| |
| <span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Fn</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">StackAllocator</span> <span class="special">></span> |
| <span class="identifier">pull_type</span><span class="special">(</span> <span class="identifier">Fn</span> <span class="special">&&</span> <span class="identifier">fn</span><span class="special">,</span> <span class="identifier">attributes</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">attr</span><span class="special">,</span> <span class="identifier">StackAllocator</span> <span class="identifier">stack_alloc</span><span class="special">);</span> |
| |
| <span class="identifier">pull_type</span><span class="special">(</span> <span class="identifier">pull_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> |
| |
| <span class="identifier">pull_type</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">=(</span> <span class="identifier">pull_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> |
| |
| <span class="special">~</span><span class="identifier">pull_type</span><span class="special">();</span> |
| |
| <span class="identifier">pull_type</span><span class="special">(</span> <span class="identifier">pull_type</span> <span class="special">&&</span> <span class="identifier">other</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> |
| |
| <span class="identifier">pull_type</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">=(</span> <span class="identifier">pull_type</span> <span class="special">&&</span> <span class="identifier">other</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> |
| |
| <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="keyword">noexcept</span><span class="special">;</span> |
| |
| <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> |
| |
| <span class="keyword">void</span> <span class="identifier">swap</span><span class="special">(</span> <span class="identifier">pull_type</span> <span class="special">&</span> <span class="identifier">other</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> |
| |
| <span class="identifier">pull_type</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">()();</span> |
| |
| <span class="identifier">R</span> <span class="identifier">get</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="special">};</span> |
| |
| <span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">R</span> <span class="special">></span> |
| <span class="keyword">void</span> <span class="identifier">swap</span><span class="special">(</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">&</span> <span class="identifier">l</span><span class="special">,</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">&</span> <span class="identifier">r</span><span class="special">);</span> |
| |
| <span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">R</span> <span class="special">></span> |
| <span class="identifier">range_iterator</span><span class="special"><</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">>::</span><span class="identifier">type</span> <span class="identifier">begin</span><span class="special">(</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">&);</span> |
| |
| <span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">R</span> <span class="special">></span> |
| <span class="identifier">range_iterator</span><span class="special"><</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">>::</span><span class="identifier">type</span> <span class="identifier">end</span><span class="special">(</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">&);</span> |
| </pre> |
| <h6> |
| <a name="coroutine.coroutine.asymmetric.pull_coro.h0"></a> |
| <span class="phrase"><a name="coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__pull_type__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__pull_type__phrase__phrase_role__special______phrase___code_"><code class="computeroutput"><span class="identifier">pull_type</span><span class="special">()</span></code></a> |
| </h6> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl class="variablelist"> |
| <dt><span class="term">Effects:</span></dt> |
| <dd><p> |
| Creates a coroutine representing <span class="emphasis"><em>not-a-coroutine</em></span>. |
| </p></dd> |
| <dt><span class="term">Throws:</span></dt> |
| <dd><p> |
| Nothing. |
| </p></dd> |
| </dl> |
| </div> |
| <h6> |
| <a name="coroutine.coroutine.asymmetric.pull_coro.h1"></a> |
| <span class="phrase"><a name="coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__keyword__template__phrase__phrase_role__special___lt___phrase___phrase_role__keyword__typename__phrase___phrase_role__identifier__fn__phrase___phrase_role__special___gt___phrase_____________phrase_role__identifier__pull_type__phrase__phrase_role__special_____phrase___phrase_role__identifier__fn__phrase___phrase_role__special___amp__amp___phrase___phrase_role__identifier__fn__phrase__phrase_role__special_____phrase___phrase_role__identifier__attributes__phrase___phrase_role__keyword__const__phrase__phrase_role__special___amp___phrase___phrase_role__identifier__attr__phrase__phrase_role__special_____phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__keyword__template__phrase__phrase_role__special___lt___phrase___phrase_role__keyword__typename__phrase___phrase_role__identifier__fn__phrase___phrase_role__special___gt___phrase_____________phrase_role__identifier__pull_type__phrase__phrase_role__special_____phrase___phrase_role__identifier__fn__phrase___phrase_role__special___amp__amp___phrase___phrase_role__identifier__fn__phrase__phrase_role__special_____phrase___phrase_role__identifier__attributes__phrase___phrase_role__keyword__const__phrase__phrase_role__special___amp___phrase___phrase_role__identifier__attr__phrase__phrase_role__special_____phrase___code_"><code class="computeroutput"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Fn</span> |
| <span class="special">></span> <span class="identifier">pull_type</span><span class="special">(</span> <span class="identifier">Fn</span> <span class="special">&&</span> <span class="identifier">fn</span><span class="special">,</span> <span class="identifier">attributes</span> |
| <span class="keyword">const</span><span class="special">&</span> |
| <span class="identifier">attr</span><span class="special">)</span></code></a> |
| </h6> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl class="variablelist"> |
| <dt><span class="term">Preconditions:</span></dt> |
| <dd><p> |
| <code class="computeroutput"><span class="identifier">size</span></code> >= minimum_stacksize(), |
| <code class="computeroutput"><span class="identifier">size</span></code> <= maximum_stacksize() |
| when ! is_stack_unbounded(). |
| </p></dd> |
| <dt><span class="term">Effects:</span></dt> |
| <dd><p> |
| Creates a coroutine which will execute <code class="computeroutput"><span class="identifier">fn</span></code>, |
| and enters it. Argument <code class="computeroutput"><span class="identifier">attr</span></code> |
| determines stack clean-up and preserving floating-point registers. |
| </p></dd> |
| <dt><span class="term">Throws:</span></dt> |
| <dd><p> |
| Exceptions thrown inside <span class="emphasis"><em>coroutine-function</em></span>. |
| </p></dd> |
| </dl> |
| </div> |
| <h6> |
| <a name="coroutine.coroutine.asymmetric.pull_coro.h2"></a> |
| <span class="phrase"><a name="coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__keyword__template__phrase__phrase_role__special___lt___phrase___phrase_role__keyword__typename__phrase___phrase_role__identifier__fn__phrase__phrase_role__special_____phrase___phrase_role__keyword__typename__phrase___phrase_role__identifier__stackallocator__phrase___phrase_role__special___gt___phrase_____________phrase_role__identifier__pull_type__phrase__phrase_role__special_____phrase___phrase_role__identifier__fn__phrase___phrase_role__special___amp__amp___phrase___phrase_role__identifier__fn__phrase__phrase_role__special_____phrase___phrase_role__identifier__attributes__phrase___phrase_role__keyword__const__phrase__phrase_role__special___amp___phrase___phrase_role__identifier__attr__phrase__phrase_role__special_____phrase___phrase_role__identifier__stackallocator__phrase___phrase_role__keyword__const__phrase__phrase_role__special___amp___phrase___phrase_role__identifier__stack_alloc__phrase__phrase_role__special_____phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__keyword__template__phrase__phrase_role__special___lt___phrase___phrase_role__keyword__typename__phrase___phrase_role__identifier__fn__phrase__phrase_role__special_____phrase___phrase_role__keyword__typename__phrase___phrase_role__identifier__stackallocator__phrase___phrase_role__special___gt___phrase_____________phrase_role__identifier__pull_type__phrase__phrase_role__special_____phrase___phrase_role__identifier__fn__phrase___phrase_role__special___amp__amp___phrase___phrase_role__identifier__fn__phrase__phrase_role__special_____phrase___phrase_role__identifier__attributes__phrase___phrase_role__keyword__const__phrase__phrase_role__special___amp___phrase___phrase_role__identifier__attr__phrase__phrase_role__special_____phrase___phrase_role__identifier__stackallocator__phrase___phrase_role__keyword__const__phrase__phrase_role__special___amp___phrase___phrase_role__identifier__stack_alloc__phrase__phrase_role__special_____phrase___code_"><code class="computeroutput"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Fn</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">StackAllocator</span> <span class="special">></span> |
| <span class="identifier">pull_type</span><span class="special">(</span> |
| <span class="identifier">Fn</span> <span class="special">&&</span> |
| <span class="identifier">fn</span><span class="special">,</span> |
| <span class="identifier">attributes</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">attr</span><span class="special">,</span> <span class="identifier">StackAllocator</span> |
| <span class="keyword">const</span><span class="special">&</span> |
| <span class="identifier">stack_alloc</span><span class="special">)</span></code></a> |
| </h6> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl class="variablelist"> |
| <dt><span class="term">Preconditions:</span></dt> |
| <dd><p> |
| <code class="computeroutput"><span class="identifier">size</span></code> >= minimum_stacksize(), |
| <code class="computeroutput"><span class="identifier">size</span></code> <= maximum_stacksize() |
| when ! is_stack_unbounded(). |
| </p></dd> |
| <dt><span class="term">Effects:</span></dt> |
| <dd><p> |
| Creates a coroutine which will execute <code class="computeroutput"><span class="identifier">fn</span></code>. |
| Argument <code class="computeroutput"><span class="identifier">attr</span></code> determines |
| stack clean-up and preserving floating-point registers. For allocating/deallocating |
| the stack <code class="computeroutput"><span class="identifier">stack_alloc</span></code> |
| is used. |
| </p></dd> |
| <dt><span class="term">Throws:</span></dt> |
| <dd><p> |
| Exceptions thrown inside <span class="emphasis"><em>coroutine-function</em></span>. |
| </p></dd> |
| </dl> |
| </div> |
| <h6> |
| <a name="coroutine.coroutine.asymmetric.pull_coro.h3"></a> |
| <span class="phrase"><a name="coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__special_____phrase__phrase_role__identifier__pull_type__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__special_____phrase__phrase_role__identifier__pull_type__phrase__phrase_role__special______phrase___code_"><code class="computeroutput"><span class="special">~</span><span class="identifier">pull_type</span><span class="special">()</span></code></a> |
| </h6> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl class="variablelist"> |
| <dt><span class="term">Effects:</span></dt> |
| <dd><p> |
| Destroys the context and deallocates the stack. |
| </p></dd> |
| </dl> |
| </div> |
| <h6> |
| <a name="coroutine.coroutine.asymmetric.pull_coro.h4"></a> |
| <span class="phrase"><a name="coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__pull_type__phrase__phrase_role__special_____phrase___phrase_role__identifier__pull_type__phrase___phrase_role__special___amp__amp___phrase___phrase_role__identifier__other__phrase__phrase_role__special_____phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__pull_type__phrase__phrase_role__special_____phrase___phrase_role__identifier__pull_type__phrase___phrase_role__special___amp__amp___phrase___phrase_role__identifier__other__phrase__phrase_role__special_____phrase___code_"><code class="computeroutput"><span class="identifier">pull_type</span><span class="special">(</span> |
| <span class="identifier">pull_type</span> <span class="special">&&</span> |
| <span class="identifier">other</span><span class="special">)</span></code></a> |
| </h6> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl class="variablelist"> |
| <dt><span class="term">Effects:</span></dt> |
| <dd><p> |
| Moves the internal data of <code class="computeroutput"><span class="identifier">other</span></code> |
| to <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>. |
| <code class="computeroutput"><span class="identifier">other</span></code> becomes <span class="emphasis"><em>not-a-coroutine</em></span>. |
| </p></dd> |
| <dt><span class="term">Throws:</span></dt> |
| <dd><p> |
| Nothing. |
| </p></dd> |
| </dl> |
| </div> |
| <h6> |
| <a name="coroutine.coroutine.asymmetric.pull_coro.h5"></a> |
| <span class="phrase"><a name="coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__pull_type__phrase___phrase_role__special___amp___phrase___phrase_role__keyword__operator__phrase__phrase_role__special______phrase___phrase_role__identifier__pull_type__phrase___phrase_role__special___amp__amp___phrase___phrase_role__identifier__other__phrase__phrase_role__special_____phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__pull_type__phrase___phrase_role__special___amp___phrase___phrase_role__keyword__operator__phrase__phrase_role__special______phrase___phrase_role__identifier__pull_type__phrase___phrase_role__special___amp__amp___phrase___phrase_role__identifier__other__phrase__phrase_role__special_____phrase___code_"><code class="computeroutput"><span class="identifier">pull_type</span> <span class="special">&</span> |
| <span class="keyword">operator</span><span class="special">=(</span> |
| <span class="identifier">pull_type</span> <span class="special">&&</span> |
| <span class="identifier">other</span><span class="special">)</span></code></a> |
| </h6> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl class="variablelist"> |
| <dt><span class="term">Effects:</span></dt> |
| <dd><p> |
| Destroys the internal data of <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> and moves the internal data of |
| <code class="computeroutput"><span class="identifier">other</span></code> to <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>. |
| <code class="computeroutput"><span class="identifier">other</span></code> becomes <span class="emphasis"><em>not-a-coroutine</em></span>. |
| </p></dd> |
| <dt><span class="term">Throws:</span></dt> |
| <dd><p> |
| Nothing. |
| </p></dd> |
| </dl> |
| </div> |
| <h6> |
| <a name="coroutine.coroutine.asymmetric.pull_coro.h6"></a> |
| <span class="phrase"><a name="coroutine.coroutine.asymmetric.pull_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="pull_coro.html#coroutine.coroutine.asymmetric.pull_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> |
| </h6> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl class="variablelist"> |
| <dt><span class="term">Returns:</span></dt> |
| <dd><p> |
| If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> |
| refers to <span class="emphasis"><em>not-a-coroutine</em></span> or the coroutine-function |
| has returned (completed), the function returns <code class="computeroutput"><span class="keyword">false</span></code>. |
| Otherwise <code class="computeroutput"><span class="keyword">true</span></code>. |
| </p></dd> |
| <dt><span class="term">Throws:</span></dt> |
| <dd><p> |
| Nothing. |
| </p></dd> |
| </dl> |
| </div> |
| <h6> |
| <a name="coroutine.coroutine.asymmetric.pull_coro.h7"></a> |
| <span class="phrase"><a name="coroutine.coroutine.asymmetric.pull_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="pull_coro.html#coroutine.coroutine.asymmetric.pull_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> |
| </h6> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl class="variablelist"> |
| <dt><span class="term">Returns:</span></dt> |
| <dd><p> |
| If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> |
| refers to <span class="emphasis"><em>not-a-coroutine</em></span> or the coroutine-function |
| has returned (completed), the function returns <code class="computeroutput"><span class="keyword">true</span></code>. |
| Otherwise <code class="computeroutput"><span class="keyword">false</span></code>. |
| </p></dd> |
| <dt><span class="term">Throws:</span></dt> |
| <dd><p> |
| Nothing. |
| </p></dd> |
| </dl> |
| </div> |
| <h6> |
| <a name="coroutine.coroutine.asymmetric.pull_coro.h8"></a> |
| <span class="phrase"><a name="coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__pull_type__phrase__phrase_role__special___lt__gt___phrase___phrase_role__special___amp___phrase___phrase_role__keyword__operator__phrase__phrase_role__special________phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__pull_type__phrase__phrase_role__special___lt__gt___phrase___phrase_role__special___amp___phrase___phrase_role__keyword__operator__phrase__phrase_role__special________phrase___code_"><code class="computeroutput"><span class="identifier">pull_type</span><span class="special"><></span> |
| <span class="special">&</span> <span class="keyword">operator</span><span class="special">()()</span></code></a> |
| </h6> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl class="variablelist"> |
| <dt><span class="term">Preconditions:</span></dt> |
| <dd><p> |
| <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> |
| is not a <span class="emphasis"><em>not-a-coroutine</em></span>. |
| </p></dd> |
| <dt><span class="term">Effects:</span></dt> |
| <dd><p> |
| Execution control is transferred to <span class="emphasis"><em>coroutine-function</em></span> |
| (no parameter is passed to the coroutine-function). |
| </p></dd> |
| <dt><span class="term">Throws:</span></dt> |
| <dd><p> |
| Exceptions thrown inside <span class="emphasis"><em>coroutine-function</em></span>. |
| </p></dd> |
| </dl> |
| </div> |
| <h6> |
| <a name="coroutine.coroutine.asymmetric.pull_coro.h9"></a> |
| <span class="phrase"><a name="coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__r__phrase___phrase_role__identifier__get__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine.coroutine.asymmetric.pull_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> |
| </h6> |
| <pre class="programlisting"><span class="identifier">R</span> <span class="identifier">asymmetric_coroutine</span><span class="special"><</span><span class="identifier">R</span><span class="special">,</span><span class="identifier">StackAllocator</span><span class="special">>::</span><span class="identifier">pull_type</span><span class="special">::</span><span class="identifier">get</span><span class="special">();</span> |
| <span class="identifier">R</span><span class="special">&</span> <span class="identifier">asymmetric_coroutine</span><span class="special"><</span><span class="identifier">R</span><span class="special">&,</span><span class="identifier">StackAllocator</span><span class="special">>::</span><span class="identifier">pull_type</span><span class="special">::</span><span class="identifier">get</span><span class="special">();</span> |
| <span class="keyword">void</span> <span class="identifier">asymmetric_coroutine</span><span class="special"><</span><span class="keyword">void</span><span class="special">,</span><span class="identifier">StackAllocator</span><span class="special">>::</span><span class="identifier">pull_type</span><span class="special">::</span><span class="identifier">get</span><span class="special">()=</span><span class="keyword">delete</span><span class="special">;</span> |
| </pre> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl class="variablelist"> |
| <dt><span class="term">Preconditions:</span></dt> |
| <dd><p> |
| <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> |
| is not a <span class="emphasis"><em>not-a-coroutine</em></span>. |
| </p></dd> |
| <dt><span class="term">Returns:</span></dt> |
| <dd><p> |
| Returns data transferred from coroutine-function via <span class="emphasis"><em>asymmetric_coroutine<>::push_type::operator()</em></span>. |
| </p></dd> |
| <dt><span class="term">Throws:</span></dt> |
| <dd><p> |
| <code class="computeroutput"><span class="identifier">invalid_result</span></code> |
| </p></dd> |
| <dt><span class="term">Note:</span></dt> |
| <dd><p> |
| If <code class="computeroutput"><span class="identifier">R</span></code> is a move-only |
| type, you may only call <code class="computeroutput"><span class="identifier">get</span><span class="special">()</span></code> once before the next <span class="emphasis"><em>asymmetric_coroutine<>::pull_type::operator()</em></span> |
| call. |
| </p></dd> |
| </dl> |
| </div> |
| <h6> |
| <a name="coroutine.coroutine.asymmetric.pull_coro.h10"></a> |
| <span class="phrase"><a name="coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__keyword__void__phrase___phrase_role__identifier__swap__phrase__phrase_role__special_____phrase___phrase_role__identifier__pull_type__phrase___phrase_role__special___amp___phrase___phrase_role__identifier__other__phrase__phrase_role__special_____phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine.coroutine.asymmetric.pull_coro._code__phrase_role__keyword__void__phrase___phrase_role__identifier__swap__phrase__phrase_role__special_____phrase___phrase_role__identifier__pull_type__phrase___phrase_role__special___amp___phrase___phrase_role__identifier__other__phrase__phrase_role__special_____phrase___code_"><code class="computeroutput"><span class="keyword">void</span> <span class="identifier">swap</span><span class="special">(</span> <span class="identifier">pull_type</span> |
| <span class="special">&</span> <span class="identifier">other</span><span class="special">)</span></code></a> |
| </h6> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl class="variablelist"> |
| <dt><span class="term">Effects:</span></dt> |
| <dd><p> |
| Swaps the internal data from <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> with the values of <code class="computeroutput"><span class="identifier">other</span></code>. |
| </p></dd> |
| <dt><span class="term">Throws:</span></dt> |
| <dd><p> |
| Nothing. |
| </p></dd> |
| </dl> |
| </div> |
| <h6> |
| <a name="coroutine.coroutine.asymmetric.pull_coro.h11"></a> |
| <span class="phrase"><a name="coroutine.coroutine.asymmetric.pull_coro.non_member_function__code__phrase_role__identifier__swap__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine.coroutine.asymmetric.pull_coro.non_member_function__code__phrase_role__identifier__swap__phrase__phrase_role__special______phrase___code_">Non-member |
| function <code class="computeroutput"><span class="identifier">swap</span><span class="special">()</span></code></a> |
| </h6> |
| <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">R</span> <span class="special">></span> |
| <span class="keyword">void</span> <span class="identifier">swap</span><span class="special">(</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">&</span> <span class="identifier">l</span><span class="special">,</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">&</span> <span class="identifier">r</span><span class="special">);</span> |
| </pre> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl class="variablelist"> |
| <dt><span class="term">Effects:</span></dt> |
| <dd><p> |
| As if 'l.swap( r)'. |
| </p></dd> |
| </dl> |
| </div> |
| <h6> |
| <a name="coroutine.coroutine.asymmetric.pull_coro.h12"></a> |
| <span class="phrase"><a name="coroutine.coroutine.asymmetric.pull_coro.non_member_function__code__phrase_role__identifier__begin__phrase__phrase_role__special_____phrase___phrase_role__identifier__pull_type__phrase__phrase_role__special___lt___phrase___phrase_role__identifier__r__phrase___phrase_role__special___gt___phrase___phrase_role__special___amp____phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine.coroutine.asymmetric.pull_coro.non_member_function__code__phrase_role__identifier__begin__phrase__phrase_role__special_____phrase___phrase_role__identifier__pull_type__phrase__phrase_role__special___lt___phrase___phrase_role__identifier__r__phrase___phrase_role__special___gt___phrase___phrase_role__special___amp____phrase___code_">Non-member |
| function <code class="computeroutput"><span class="identifier">begin</span><span class="special">(</span> |
| <span class="identifier">pull_type</span><span class="special"><</span> |
| <span class="identifier">R</span> <span class="special">></span> |
| <span class="special">&)</span></code></a> |
| </h6> |
| <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">R</span> <span class="special">></span> |
| <span class="identifier">range_iterator</span><span class="special"><</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">>::</span><span class="identifier">type</span> <span class="identifier">begin</span><span class="special">(</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">&);</span> |
| </pre> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl class="variablelist"> |
| <dt><span class="term">Returns:</span></dt> |
| <dd><p> |
| Returns a range-iterator (input-iterator). |
| </p></dd> |
| </dl> |
| </div> |
| <h6> |
| <a name="coroutine.coroutine.asymmetric.pull_coro.h13"></a> |
| <span class="phrase"><a name="coroutine.coroutine.asymmetric.pull_coro.non_member_function__code__phrase_role__identifier__end__phrase__phrase_role__special_____phrase___phrase_role__identifier__pull_type__phrase__phrase_role__special___lt___phrase___phrase_role__identifier__r__phrase___phrase_role__special___gt___phrase___phrase_role__special___amp____phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine.coroutine.asymmetric.pull_coro.non_member_function__code__phrase_role__identifier__end__phrase__phrase_role__special_____phrase___phrase_role__identifier__pull_type__phrase__phrase_role__special___lt___phrase___phrase_role__identifier__r__phrase___phrase_role__special___gt___phrase___phrase_role__special___amp____phrase___code_">Non-member |
| function <code class="computeroutput"><span class="identifier">end</span><span class="special">(</span> |
| <span class="identifier">pull_type</span><span class="special"><</span> |
| <span class="identifier">R</span> <span class="special">></span> |
| <span class="special">&)</span></code></a> |
| </h6> |
| <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">R</span> <span class="special">></span> |
| <span class="identifier">range_iterator</span><span class="special"><</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">>::</span><span class="identifier">type</span> <span class="identifier">end</span><span class="special">(</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">&);</span> |
| </pre> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl class="variablelist"> |
| <dt><span class="term">Returns:</span></dt> |
| <dd><p> |
| Returns an end range-iterator (input-iterator). |
| </p></dd> |
| <dt><span class="term">Note:</span></dt> |
| <dd><p> |
| When first obtained from <code class="computeroutput"><span class="identifier">begin</span><span class="special">(</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> |
| <span class="special">></span> <span class="special">&)</span></code>, |
| or after some number of increment operations, an iterator will compare |
| equal to the iterator returned by <code class="computeroutput"><span class="identifier">end</span><span class="special">(</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> |
| <span class="special">></span> <span class="special">&)</span></code> |
| when the corresponding <span class="emphasis"><em>asymmetric_coroutine<>::pull_type::operator |
| bool</em></span> would return <code class="computeroutput"><span class="keyword">false</span></code>. |
| </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 © 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="../asymmetric.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../asymmetric.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="push_coro.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
