async_result.html
7.01 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>async_result</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="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="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="async_read_until/overload12.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="async_result/async_result.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.async_result"></a><a class="link" href="async_result.html" title="async_result">async_result</a>
</h3></div></div></div>
<p>
An interface for customising the behaviour of an initiating function.
</p>
<pre class="programlisting">template<
typename CompletionToken,
typename Signature>
class async_result
</pre>
<h5>
<a name="asio.reference.async_result.h0"></a>
<span><a name="asio.reference.async_result.types"></a></span><a class="link" href="async_result.html#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="asio.reference.async_result.h1"></a>
<span><a name="asio.reference.async_result.member_functions"></a></span><a class="link" href="async_result.html#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" 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="asio.reference.async_result.h2"></a>
<span><a name="asio.reference.async_result.requirements"></a></span><a class="link" href="async_result.html#asio.reference.async_result.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/async_result.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">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-2020 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="../../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="async_result/async_result.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>