use_awaitable_t.html
6.31 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
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>use_awaitable_t</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="use_awaitable.html" title="use_awaitable">
<link rel="next" href="use_awaitable_t/as_default_on.html" title="use_awaitable_t::as_default_on">
</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="use_awaitable.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="use_awaitable_t/as_default_on.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.use_awaitable_t"></a><a class="link" href="use_awaitable_t.html" title="use_awaitable_t">use_awaitable_t</a>
</h3></div></div></div>
<p>
A completion token that represents the currently executing coroutine.
</p>
<pre class="programlisting">template<
typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a> = any_io_executor>
struct use_awaitable_t
</pre>
<h5>
<a name="asio.reference.use_awaitable_t.h0"></a>
<span><a name="asio.reference.use_awaitable_t.types"></a></span><a class="link" href="use_awaitable_t.html#asio.reference.use_awaitable_t.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="use_awaitable_t__executor_with_default.html" title="use_awaitable_t::executor_with_default"><span class="bold"><strong>executor_with_default</strong></span></a>
</p>
</td>
<td>
<p>
Adapts an executor to add the use_awaitable_t completion token
as the default.
</p>
</td>
</tr></tbody>
</table></div>
<h5>
<a name="asio.reference.use_awaitable_t.h1"></a>
<span><a name="asio.reference.use_awaitable_t.member_functions"></a></span><a class="link" href="use_awaitable_t.html#asio.reference.use_awaitable_t.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="use_awaitable_t/as_default_on.html" title="use_awaitable_t::as_default_on"><span class="bold"><strong>as_default_on</strong></span></a> <span class="silver">[static]</span>
</p>
</td>
<td>
<p>
Function helper to adapt an I/O object to use use_awaitable_t as
its default completion token type.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="use_awaitable_t/use_awaitable_t.html" title="use_awaitable_t::use_awaitable_t"><span class="bold"><strong>use_awaitable_t</strong></span></a> <span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Default constructor. <br> <span class="silver"> —</span><br> Constructor used to specify
file name, line, and function name.
</p>
</td>
</tr>
</tbody>
</table></div>
<p>
The <code class="computeroutput">use_awaitable_t</code> class, with its value <code class="computeroutput">use_awaitable</code>,
is used to represent the currently executing coroutine. This completion token
may be passed as a handler to an asynchronous operation. For example:
</p>
<pre class="programlisting">awaitable<void> my_coroutine()
{
std::size_t n = co_await my_socket.async_read_some(buffer, use_awaitable);
...
}
</pre>
<p>
When used with co_await, the initiating function (<code class="computeroutput">async_read_some</code>
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.use_awaitable_t.h2"></a>
<span><a name="asio.reference.use_awaitable_t.requirements"></a></span><a class="link" href="use_awaitable_t.html#asio.reference.use_awaitable_t.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/use_awaitable.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="use_awaitable.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="use_awaitable_t/as_default_on.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>