generic-library/boost
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
boost/doc/html/boost_asio/reference/async_result.html
Edouard DUPIN d0115b733d [DEV] add v1.76.0
2021-10-05 21:37:46 +02:00

200 lines
7.8 KiB
HTML
Raw Blame History

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>async_result</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="async_read_until/overload12.html" title="async_read_until (12 of 12 overloads)">
<link rel="next" href="async_result/async_result.html" title="async_result::async_result">
</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="async_read_until/overload12.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="async_result/async_result.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_asio.reference.async_result"></a><a class="link" href="async_result.html" title="async_result">async_result</a>
</h3></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.async_result"></a>
</p>
<p>
An interface for customising the behaviour of an initiating function.
</p>
<pre class="programlisting">template&lt;
typename CompletionToken,
typename Signature&gt;
class async_result
</pre>
<h5>
<a name="boost_asio.reference.async_result.h0"></a>
<span class="phrase"><a name="boost_asio.reference.async_result.types"></a></span><a class="link" href="async_result.html#boost_asio.reference.async_result.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="async_result/completion_handler_type.html" title="async_result::completion_handler_type"><span class="bold"><strong>completion_handler_type</strong></span></a>
</p>
</td>
<td>
<p>
The concrete completion handler type for the specific signature.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="async_result/return_type.html" title="async_result::return_type"><span class="bold"><strong>return_type</strong></span></a>
</p>
</td>
<td>
<p>
The return type of the initiating function.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="boost_asio.reference.async_result.h1"></a>
<span class="phrase"><a name="boost_asio.reference.async_result.member_functions"></a></span><a class="link" href="async_result.html#boost_asio.reference.async_result.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="async_result/async_result.html" title="async_result::async_result"><span class="bold"><strong>async_result</strong></span></a> <span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Construct an async result from a given handler.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="async_result/get.html" title="async_result::get"><span class="bold"><strong>get</strong></span></a>
</p>
</td>
<td>
<p>
Obtain the value to be returned from the initiating function.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="async_result/initiate.html" title="async_result::initiate"><span class="bold"><strong>initiate</strong></span></a> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Initiate the asynchronous operation that will produce the result,
and obtain the value to be returned from the initiating function.
</p>
</td>
</tr>
</tbody>
</table></div>
<p>
The <a class="link" href="async_result.html" title="async_result"><code class="computeroutput">async_result</code></a>
traits class is used for determining:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
the concrete completion handler type to be called at the end of the asynchronous
operation;
</li>
<li class="listitem">
the initiating function return type; and
</li>
<li class="listitem">
how the return value of the initiating function is obtained.
</li>
</ul></div>
<p>
The trait allows the handler and return types to be determined at the point
where the specific completion handler signature is known.
</p>
<p>
This template may be specialised for user-defined completion token types.
The primary template assumes that the CompletionToken is the completion handler.
</p>
<h5>
<a name="boost_asio.reference.async_result.h2"></a>
<span class="phrase"><a name="boost_asio.reference.async_result.requirements"></a></span><a class="link" href="async_result.html#boost_asio.reference.async_result.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/async_result.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
</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 © 2003-2021 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="async_read_until/overload12.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="async_result/async_result.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink