1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>windows::basic_overlapped_handle</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="windows__basic_object_handle__rebind_executor/other.html" title="windows::basic_object_handle::rebind_executor::other"> 10<link rel="next" href="windows__basic_overlapped_handle/assign.html" title="windows::basic_overlapped_handle::assign"> 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="windows__basic_object_handle__rebind_executor/other.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="windows__basic_overlapped_handle/assign.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.windows__basic_overlapped_handle"></a><a class="link" href="windows__basic_overlapped_handle.html" title="windows::basic_overlapped_handle">windows::basic_overlapped_handle</a> 28</h3></div></div></div> 29<p> 30 Provides Windows handle functionality for objects that support overlapped 31 I/O. 32 </p> 33<pre class="programlisting">template< 34 typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a> = any_io_executor> 35class basic_overlapped_handle 36</pre> 37<h5> 38<a name="boost_asio.reference.windows__basic_overlapped_handle.h0"></a> 39 <span class="phrase"><a name="boost_asio.reference.windows__basic_overlapped_handle.types"></a></span><a class="link" href="windows__basic_overlapped_handle.html#boost_asio.reference.windows__basic_overlapped_handle.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="windows__basic_overlapped_handle__rebind_executor.html" title="windows::basic_overlapped_handle::rebind_executor"><span class="bold"><strong>rebind_executor</strong></span></a> 63 </p> 64 </td> 65<td> 66 <p> 67 Rebinds the handle type to another executor. 68 </p> 69 </td> 70</tr> 71<tr> 72<td> 73 <p> 74 <a class="link" href="windows__basic_overlapped_handle/executor_type.html" title="windows::basic_overlapped_handle::executor_type"><span class="bold"><strong>executor_type</strong></span></a> 75 </p> 76 </td> 77<td> 78 <p> 79 The type of the executor associated with the object. 80 </p> 81 </td> 82</tr> 83<tr> 84<td> 85 <p> 86 <a class="link" href="windows__basic_overlapped_handle/lowest_layer_type.html" title="windows::basic_overlapped_handle::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a> 87 </p> 88 </td> 89<td> 90 <p> 91 An overlapped_handle is always the lowest layer. 92 </p> 93 </td> 94</tr> 95<tr> 96<td> 97 <p> 98 <a class="link" href="windows__basic_overlapped_handle/native_handle_type.html" title="windows::basic_overlapped_handle::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a> 99 </p> 100 </td> 101<td> 102 <p> 103 The native representation of a handle. 104 </p> 105 </td> 106</tr> 107</tbody> 108</table></div> 109<h5> 110<a name="boost_asio.reference.windows__basic_overlapped_handle.h1"></a> 111 <span class="phrase"><a name="boost_asio.reference.windows__basic_overlapped_handle.member_functions"></a></span><a class="link" href="windows__basic_overlapped_handle.html#boost_asio.reference.windows__basic_overlapped_handle.member_functions">Member 112 Functions</a> 113 </h5> 114<div class="informaltable"><table class="table"> 115<colgroup> 116<col> 117<col> 118</colgroup> 119<thead><tr> 120<th> 121 <p> 122 Name 123 </p> 124 </th> 125<th> 126 <p> 127 Description 128 </p> 129 </th> 130</tr></thead> 131<tbody> 132<tr> 133<td> 134 <p> 135 <a class="link" href="windows__basic_overlapped_handle/assign.html" title="windows::basic_overlapped_handle::assign"><span class="bold"><strong>assign</strong></span></a> 136 </p> 137 </td> 138<td> 139 <p> 140 Assign an existing native handle to the handle. 141 </p> 142 </td> 143</tr> 144<tr> 145<td> 146 <p> 147 <a class="link" href="windows__basic_overlapped_handle/basic_overlapped_handle.html" title="windows::basic_overlapped_handle::basic_overlapped_handle"><span class="bold"><strong>basic_overlapped_handle</strong></span></a> <span class="silver">[constructor]</span> 148 </p> 149 </td> 150<td> 151 <p> 152 Construct an overlapped handle without opening it. <br> <span class="silver"> —</span><br> 153 Construct an overlapped handle on an existing native handle. <br> 154 <span class="silver"> —</span><br> Move-construct an overlapped handle from another. 155 </p> 156 </td> 157</tr> 158<tr> 159<td> 160 <p> 161 <a class="link" href="windows__basic_overlapped_handle/cancel.html" title="windows::basic_overlapped_handle::cancel"><span class="bold"><strong>cancel</strong></span></a> 162 </p> 163 </td> 164<td> 165 <p> 166 Cancel all asynchronous operations associated with the handle. 167 </p> 168 </td> 169</tr> 170<tr> 171<td> 172 <p> 173 <a class="link" href="windows__basic_overlapped_handle/close.html" title="windows::basic_overlapped_handle::close"><span class="bold"><strong>close</strong></span></a> 174 </p> 175 </td> 176<td> 177 <p> 178 Close the handle. 179 </p> 180 </td> 181</tr> 182<tr> 183<td> 184 <p> 185 <a class="link" href="windows__basic_overlapped_handle/get_executor.html" title="windows::basic_overlapped_handle::get_executor"><span class="bold"><strong>get_executor</strong></span></a> 186 </p> 187 </td> 188<td> 189 <p> 190 Get the executor associated with the object. 191 </p> 192 </td> 193</tr> 194<tr> 195<td> 196 <p> 197 <a class="link" href="windows__basic_overlapped_handle/is_open.html" title="windows::basic_overlapped_handle::is_open"><span class="bold"><strong>is_open</strong></span></a> 198 </p> 199 </td> 200<td> 201 <p> 202 Determine whether the handle is open. 203 </p> 204 </td> 205</tr> 206<tr> 207<td> 208 <p> 209 <a class="link" href="windows__basic_overlapped_handle/lowest_layer.html" title="windows::basic_overlapped_handle::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a> 210 </p> 211 </td> 212<td> 213 <p> 214 Get a reference to the lowest layer. <br> <span class="silver"> —</span><br> Get a const 215 reference to the lowest layer. 216 </p> 217 </td> 218</tr> 219<tr> 220<td> 221 <p> 222 <a class="link" href="windows__basic_overlapped_handle/native_handle.html" title="windows::basic_overlapped_handle::native_handle"><span class="bold"><strong>native_handle</strong></span></a> 223 </p> 224 </td> 225<td> 226 <p> 227 Get the native handle representation. 228 </p> 229 </td> 230</tr> 231<tr> 232<td> 233 <p> 234 <a class="link" href="windows__basic_overlapped_handle/operator_eq_.html" title="windows::basic_overlapped_handle::operator="><span class="bold"><strong>operator=</strong></span></a> 235 </p> 236 </td> 237<td> 238 <p> 239 Move-assign an overlapped handle from another. 240 </p> 241 </td> 242</tr> 243</tbody> 244</table></div> 245<h5> 246<a name="boost_asio.reference.windows__basic_overlapped_handle.h2"></a> 247 <span class="phrase"><a name="boost_asio.reference.windows__basic_overlapped_handle.protected_member_functions"></a></span><a class="link" href="windows__basic_overlapped_handle.html#boost_asio.reference.windows__basic_overlapped_handle.protected_member_functions">Protected 248 Member Functions</a> 249 </h5> 250<div class="informaltable"><table class="table"> 251<colgroup> 252<col> 253<col> 254</colgroup> 255<thead><tr> 256<th> 257 <p> 258 Name 259 </p> 260 </th> 261<th> 262 <p> 263 Description 264 </p> 265 </th> 266</tr></thead> 267<tbody><tr> 268<td> 269 <p> 270 <a class="link" href="windows__basic_overlapped_handle/_basic_overlapped_handle.html" title="windows::basic_overlapped_handle::~basic_overlapped_handle"><span class="bold"><strong>~basic_overlapped_handle</strong></span></a> <span class="silver">[destructor]</span> 271 </p> 272 </td> 273<td> 274 <p> 275 Protected destructor to prevent deletion through this type. 276 </p> 277 </td> 278</tr></tbody> 279</table></div> 280<p> 281 The <a class="link" href="windows__overlapped_handle.html" title="windows::overlapped_handle"><code class="computeroutput">windows::overlapped_handle</code></a> 282 class provides the ability to wrap a Windows handle. The underlying object 283 referred to by the handle must support overlapped I/O. 284 </p> 285<h5> 286<a name="boost_asio.reference.windows__basic_overlapped_handle.h3"></a> 287 <span class="phrase"><a name="boost_asio.reference.windows__basic_overlapped_handle.thread_safety"></a></span><a class="link" href="windows__basic_overlapped_handle.html#boost_asio.reference.windows__basic_overlapped_handle.thread_safety">Thread 288 Safety</a> 289 </h5> 290<p> 291 <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe. 292 </p> 293<p> 294 <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe. 295 </p> 296<h5> 297<a name="boost_asio.reference.windows__basic_overlapped_handle.h4"></a> 298 <span class="phrase"><a name="boost_asio.reference.windows__basic_overlapped_handle.requirements"></a></span><a class="link" href="windows__basic_overlapped_handle.html#boost_asio.reference.windows__basic_overlapped_handle.requirements">Requirements</a> 299 </h5> 300<p> 301 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/basic_overlapped_handle.hpp</code> 302 </p> 303<p> 304 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> 305 </p> 306</div> 307<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 308<td align="left"></td> 309<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 310 Kohlhoff<p> 311 Distributed under the Boost Software License, Version 1.0. (See accompanying 312 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>) 313 </p> 314</div></td> 315</tr></table> 316<hr> 317<div class="spirit-nav"> 318<a accesskey="p" href="windows__basic_object_handle__rebind_executor/other.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="windows__basic_overlapped_handle/assign.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 319</div> 320</body> 321</html> 322
