3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>windows::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__object_handle.html" title="windows::object_handle">
10 <link rel="next" href="windows__overlapped_ptr.html" title="windows::overlapped_ptr">
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>
22 <div class="spirit-nav">
23 <a accesskey="p" href="windows__object_handle.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__overlapped_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="titlepage"><div><div><h3 class="title">
27 <a name="boost_asio.reference.windows__overlapped_handle"></a><a class="link" href="windows__overlapped_handle.html" title="windows::overlapped_handle">windows::overlapped_handle</a>
28 </h3></div></div></div>
30 <a class="indexterm" name="boost_asio.indexterm.windows__overlapped_handle"></a>
32 for the typical usage of an overlapped handle.
34 <pre class="programlisting">typedef basic_overlapped_handle overlapped_handle;
37 <a name="boost_asio.reference.windows__overlapped_handle.h0"></a>
38 <span class="phrase"><a name="boost_asio.reference.windows__overlapped_handle.types"></a></span><a class="link" href="windows__overlapped_handle.html#boost_asio.reference.windows__overlapped_handle.types">Types</a>
40 <div class="informaltable"><table class="table">
61 <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>
66 Rebinds the handle type to another executor.
73 <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>
78 The type of the executor associated with the object.
85 <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>
90 An overlapped_handle is always the lowest layer.
97 <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>
102 The native representation of a handle.
109 <a name="boost_asio.reference.windows__overlapped_handle.h1"></a>
110 <span class="phrase"><a name="boost_asio.reference.windows__overlapped_handle.member_functions"></a></span><a class="link" href="windows__overlapped_handle.html#boost_asio.reference.windows__overlapped_handle.member_functions">Member
113 <div class="informaltable"><table class="table">
134 <a class="link" href="windows__basic_overlapped_handle/assign.html" title="windows::basic_overlapped_handle::assign"><span class="bold"><strong>assign</strong></span></a>
139 Assign an existing native handle to the handle.
146 <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>
151 Construct an overlapped handle without opening it. <br> <span class="silver"> —</span><br>
152 Construct an overlapped handle on an existing native handle. <br>
153 <span class="silver"> —</span><br> Move-construct an overlapped handle from another.
160 <a class="link" href="windows__basic_overlapped_handle/cancel.html" title="windows::basic_overlapped_handle::cancel"><span class="bold"><strong>cancel</strong></span></a>
165 Cancel all asynchronous operations associated with the handle.
172 <a class="link" href="windows__basic_overlapped_handle/close.html" title="windows::basic_overlapped_handle::close"><span class="bold"><strong>close</strong></span></a>
184 <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>
189 Get the executor associated with the object.
196 <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>
201 Determine whether the handle is open.
208 <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>
213 Get a reference to the lowest layer. <br> <span class="silver"> —</span><br> Get a const
214 reference to the lowest layer.
221 <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>
226 Get the native handle representation.
233 <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>
238 Move-assign an overlapped handle from another.
245 <a name="boost_asio.reference.windows__overlapped_handle.h2"></a>
246 <span class="phrase"><a name="boost_asio.reference.windows__overlapped_handle.protected_member_functions"></a></span><a class="link" href="windows__overlapped_handle.html#boost_asio.reference.windows__overlapped_handle.protected_member_functions">Protected
249 <div class="informaltable"><table class="table">
269 <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>
274 Protected destructor to prevent deletion through this type.
280 <a name="boost_asio.reference.windows__overlapped_handle.h3"></a>
281 <span class="phrase"><a name="boost_asio.reference.windows__overlapped_handle.protected_data_members"></a></span><a class="link" href="windows__overlapped_handle.html#boost_asio.reference.windows__overlapped_handle.protected_data_members">Protected
284 <div class="informaltable"><table class="table">
304 <a class="link" href="windows__basic_overlapped_handle/impl_.html" title="windows::basic_overlapped_handle::impl_"><span class="bold"><strong>impl_</strong></span></a>
312 The <a class="link" href="windows__overlapped_handle.html" title="windows::overlapped_handle"><code class="computeroutput">windows::overlapped_handle</code></a>
313 class provides the ability to wrap a Windows handle. The underlying object
314 referred to by the handle must support overlapped I/O.
317 <a name="boost_asio.reference.windows__overlapped_handle.h4"></a>
318 <span class="phrase"><a name="boost_asio.reference.windows__overlapped_handle.thread_safety"></a></span><a class="link" href="windows__overlapped_handle.html#boost_asio.reference.windows__overlapped_handle.thread_safety">Thread
322 <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
325 <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
328 <a name="boost_asio.reference.windows__overlapped_handle.h5"></a>
329 <span class="phrase"><a name="boost_asio.reference.windows__overlapped_handle.requirements"></a></span><a class="link" href="windows__overlapped_handle.html#boost_asio.reference.windows__overlapped_handle.requirements">Requirements</a>
332 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/overlapped_handle.hpp</code>
335 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
338 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
339 <td align="left"></td>
340 <td align="right"><div class="copyright-footer">Copyright © 2003-2019 Christopher M. Kohlhoff<p>
341 Distributed under the Boost Software License, Version 1.0. (See accompanying
342 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>)
347 <div class="spirit-nav">
348 <a accesskey="p" href="windows__object_handle.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__overlapped_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>