244 lines
10 KiB
HTML
244 lines
10 KiB
HTML
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
|
|
<title>yield_context</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="../reference.html" title="Reference">
|
||
|
|
<link rel="prev" href="write_at/overload8.html" title="write_at (8 of 8 overloads)">
|
||
|
|
<link rel="next" href="../net_ts.html" title="Networking TS compatibility">
|
||
|
|
<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="write_at/overload8.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="../net_ts.html"><img src="../../next.png" alt="Next"></a>
|
||
|
|
</div>
|
||
|
|
<div class="section">
|
||
|
|
<div class="titlepage"><div><div><h3 class="title">
|
||
|
|
<a name="asio.reference.yield_context"></a><a class="link" href="yield_context.html" title="yield_context">yield_context</a>
|
||
|
|
</h3></div></div></div>
|
||
|
|
<p>
|
||
|
|
<a class="indexterm" name="asio.indexterm.yield_context"></a>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
A <a class="link" href="../overview/model/completion_tokens.html" title="Completion Tokens">completion token</a>
|
||
|
|
object that represents the currently executing coroutine.
|
||
|
|
</p>
|
||
|
|
<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">basic_yield_context</span><span class="special"><</span> <span class="identifier">any_io_executor</span> <span class="special">></span> <span class="identifier">yield_context</span><span class="special">;</span>
|
||
|
|
</pre>
|
||
|
|
<h5>
|
||
|
|
<a name="asio.reference.yield_context.h0"></a>
|
||
|
|
<span><a name="asio.reference.yield_context.types"></a></span><a class="link" href="yield_context.html#asio.reference.yield_context.types">Types</a>
|
||
|
|
</h5>
|
||
|
|
<div class="informaltable"><table class="table">
|
||
|
|
<colgroup>
|
||
|
|
<col>
|
||
|
|
<col>
|
||
|
|
</colgroup>
|
||
|
|
<thead><tr>
|
||
|
|
<th>
|
||
|
|
<p>
|
||
|
|
Name
|
||
|
|
</p>
|
||
|
|
</th>
|
||
|
|
<th>
|
||
|
|
<p>
|
||
|
|
Description
|
||
|
|
</p>
|
||
|
|
</th>
|
||
|
|
</tr></thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_yield_context/cancellation_slot_type.html" title="basic_yield_context::cancellation_slot_type"><span class="bold"><strong>cancellation_slot_type</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
The cancellation slot type associated with the yield context.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_yield_context/executor_type.html" title="basic_yield_context::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
The executor type associated with the yield context.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table></div>
|
||
|
|
<h5>
|
||
|
|
<a name="asio.reference.yield_context.h1"></a>
|
||
|
|
<span><a name="asio.reference.yield_context.member_functions"></a></span><a class="link" href="yield_context.html#asio.reference.yield_context.member_functions">Member
|
||
|
|
Functions</a>
|
||
|
|
</h5>
|
||
|
|
<div class="informaltable"><table class="table">
|
||
|
|
<colgroup>
|
||
|
|
<col>
|
||
|
|
<col>
|
||
|
|
</colgroup>
|
||
|
|
<thead><tr>
|
||
|
|
<th>
|
||
|
|
<p>
|
||
|
|
Name
|
||
|
|
</p>
|
||
|
|
</th>
|
||
|
|
<th>
|
||
|
|
<p>
|
||
|
|
Description
|
||
|
|
</p>
|
||
|
|
</th>
|
||
|
|
</tr></thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_yield_context/basic_yield_context.html" title="basic_yield_context::basic_yield_context"><span class="bold"><strong>basic_yield_context</strong></span></a> <span class="silver">[constructor]</span>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Construct a yield context from another yield context type.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_yield_context/cancelled.html" title="basic_yield_context::cancelled"><span class="bold"><strong>cancelled</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Determine whether the current coroutine has been cancelled.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_yield_context/get_cancellation_slot.html" title="basic_yield_context::get_cancellation_slot"><span class="bold"><strong>get_cancellation_slot</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Get the cancellation slot associated with the coroutine.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_yield_context/get_cancellation_state.html" title="basic_yield_context::get_cancellation_state"><span class="bold"><strong>get_cancellation_state</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Get the cancellation state associated with the coroutine.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_yield_context/get_executor.html" title="basic_yield_context::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Get the executor associated with the yield context.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_yield_context/operator_lb__rb_.html" title="basic_yield_context::operator[]"><span class="bold"><strong>operator[]</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Return a yield context that sets the specified error_code.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_yield_context/reset_cancellation_state.html" title="basic_yield_context::reset_cancellation_state"><span class="bold"><strong>reset_cancellation_state</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Reset the cancellation state associated with the coroutine.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="basic_yield_context/throw_if_cancelled.html" title="basic_yield_context::throw_if_cancelled"><span class="bold"><strong>throw_if_cancelled</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Determine whether the coroutine throws if trying to suspend when
|
||
|
|
it has been cancelled. <br> <span class="silver"> —</span><br> Set whether the coroutine
|
||
|
|
throws if trying to suspend when it has been cancelled.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table></div>
|
||
|
|
<p>
|
||
|
|
The <a class="link" href="basic_yield_context.html" title="basic_yield_context"><code class="computeroutput"><span class="identifier">basic_yield_context</span></code></a>
|
||
|
|
class is a completion token type that is used to represent the currently
|
||
|
|
executing stackful coroutine. A <a class="link" href="basic_yield_context.html" title="basic_yield_context"><code class="computeroutput"><span class="identifier">basic_yield_context</span></code></a> object may be
|
||
|
|
passed as a completion token to an asynchronous operation. For example:
|
||
|
|
</p>
|
||
|
|
<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Executor</span><span class="special">></span>
|
||
|
|
<span class="keyword">void</span> <span class="identifier">my_coroutine</span><span class="special">(</span><span class="identifier">basic_yield_context</span><span class="special"><</span><span class="identifier">Executor</span><span class="special">></span> <span class="identifier">yield</span><span class="special">)</span>
|
||
|
|
<span class="special">{</span>
|
||
|
|
<span class="special">...</span>
|
||
|
|
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">n</span> <span class="special">=</span> <span class="identifier">my_socket</span><span class="special">.</span><span class="identifier">async_read_some</span><span class="special">(</span><span class="identifier">buffer</span><span class="special">,</span> <span class="identifier">yield</span><span class="special">);</span>
|
||
|
|
<span class="special">...</span>
|
||
|
|
<span class="special">}</span>
|
||
|
|
</pre>
|
||
|
|
<p>
|
||
|
|
The initiating function (async_read_some in the above example) suspends the
|
||
|
|
current coroutine. The coroutine is resumed when the asynchronous operation
|
||
|
|
completes, and the result of the operation is returned.
|
||
|
|
</p>
|
||
|
|
<h5>
|
||
|
|
<a name="asio.reference.yield_context.h2"></a>
|
||
|
|
<span><a name="asio.reference.yield_context.requirements"></a></span><a class="link" href="yield_context.html#asio.reference.yield_context.requirements">Requirements</a>
|
||
|
|
</h5>
|
||
|
|
<p>
|
||
|
|
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/spawn.hpp</code>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
<span class="emphasis"><em>Convenience header: </em></span>None
|
||
|
|
</p>
|
||
|
|
</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="write_at/overload8.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="../net_ts.html"><img src="../../next.png" alt="Next"></a>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|