1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>awaitable</title> 5<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../reference.html" title="Reference"> 9<link rel="prev" href="async_write_at/overload4.html" title="async_write_at (4 of 4 overloads)"> 10<link rel="next" href="awaitable/awaitable.html" title="awaitable::awaitable"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 15<td align="center"><a href="../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="async_write_at/overload4.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="awaitable/awaitable.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h3 class="title"> 27<a name="boost_asio.reference.awaitable"></a><a class="link" href="awaitable.html" title="awaitable">awaitable</a> 28</h3></div></div></div> 29<p> 30 The return type of a coroutine or asynchronous operation. 31 </p> 32<pre class="programlisting">template< 33 typename T, 34 typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a> = any_io_executor> 35class awaitable 36</pre> 37<h5> 38<a name="boost_asio.reference.awaitable.h0"></a> 39 <span class="phrase"><a name="boost_asio.reference.awaitable.types"></a></span><a class="link" href="awaitable.html#boost_asio.reference.awaitable.types">Types</a> 40 </h5> 41<div class="informaltable"><table class="table"> 42<colgroup> 43<col> 44<col> 45</colgroup> 46<thead><tr> 47<th> 48 <p> 49 Name 50 </p> 51 </th> 52<th> 53 <p> 54 Description 55 </p> 56 </th> 57</tr></thead> 58<tbody> 59<tr> 60<td> 61 <p> 62 <a class="link" href="awaitable/executor_type.html" title="awaitable::executor_type"><span class="bold"><strong>executor_type</strong></span></a> 63 </p> 64 </td> 65<td> 66 <p> 67 The executor type that will be used for the coroutine. 68 </p> 69 </td> 70</tr> 71<tr> 72<td> 73 <p> 74 <a class="link" href="awaitable/value_type.html" title="awaitable::value_type"><span class="bold"><strong>value_type</strong></span></a> 75 </p> 76 </td> 77<td> 78 <p> 79 The type of the awaited value. 80 </p> 81 </td> 82</tr> 83</tbody> 84</table></div> 85<h5> 86<a name="boost_asio.reference.awaitable.h1"></a> 87 <span class="phrase"><a name="boost_asio.reference.awaitable.member_functions"></a></span><a class="link" href="awaitable.html#boost_asio.reference.awaitable.member_functions">Member 88 Functions</a> 89 </h5> 90<div class="informaltable"><table class="table"> 91<colgroup> 92<col> 93<col> 94</colgroup> 95<thead><tr> 96<th> 97 <p> 98 Name 99 </p> 100 </th> 101<th> 102 <p> 103 Description 104 </p> 105 </th> 106</tr></thead> 107<tbody> 108<tr> 109<td> 110 <p> 111 <a class="link" href="awaitable/awaitable.html" title="awaitable::awaitable"><span class="bold"><strong>awaitable</strong></span></a> <span class="silver">[constructor]</span> 112 </p> 113 </td> 114<td> 115 <p> 116 Default constructor. <br> <span class="silver"> —</span><br> Move constructor. 117 </p> 118 </td> 119</tr> 120<tr> 121<td> 122 <p> 123 <a class="link" href="awaitable/valid.html" title="awaitable::valid"><span class="bold"><strong>valid</strong></span></a> 124 </p> 125 </td> 126<td> 127 <p> 128 Checks if the awaitable refers to a future result. 129 </p> 130 </td> 131</tr> 132<tr> 133<td> 134 <p> 135 <a class="link" href="awaitable/_awaitable.html" title="awaitable::~awaitable"><span class="bold"><strong>~awaitable</strong></span></a> <span class="silver">[destructor]</span> 136 </p> 137 </td> 138<td> 139 <p> 140 Destructor. 141 </p> 142 </td> 143</tr> 144</tbody> 145</table></div> 146<h5> 147<a name="boost_asio.reference.awaitable.h2"></a> 148 <span class="phrase"><a name="boost_asio.reference.awaitable.requirements"></a></span><a class="link" href="awaitable.html#boost_asio.reference.awaitable.requirements">Requirements</a> 149 </h5> 150<p> 151 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/awaitable.hpp</code> 152 </p> 153<p> 154 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> 155 </p> 156</div> 157<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 158<td align="left"></td> 159<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 160 Kohlhoff<p> 161 Distributed under the Boost Software License, Version 1.0. (See accompanying 162 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>) 163 </p> 164</div></td> 165</tr></table> 166<hr> 167<div class="spirit-nav"> 168<a accesskey="p" href="async_write_at/overload4.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="awaitable/awaitable.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 169</div> 170</body> 171</html> 172
