3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>windows::basic_object_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="wait_traits/to_wait_duration/overload2.html" title="wait_traits::to_wait_duration (2 of 2 overloads)">
10 <link rel="next" href="windows__basic_object_handle/assign.html" title="windows::basic_object_handle::assign">
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="wait_traits/to_wait_duration/overload2.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_object_handle/assign.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__basic_object_handle"></a><a class="link" href="windows__basic_object_handle.html" title="windows::basic_object_handle">windows::basic_object_handle</a>
28 </h3></div></div></div>
30 Provides object-oriented handle functionality.
32 <pre class="programlisting">template<
33 typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a> = executor>
34 class basic_object_handle
37 <a name="boost_asio.reference.windows__basic_object_handle.h0"></a>
38 <span class="phrase"><a name="boost_asio.reference.windows__basic_object_handle.types"></a></span><a class="link" href="windows__basic_object_handle.html#boost_asio.reference.windows__basic_object_handle.types">Types</a>
40 <div class="informaltable"><table class="table">
61 <a class="link" href="windows__basic_object_handle__rebind_executor.html" title="windows::basic_object_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_object_handle/executor_type.html" title="windows::basic_object_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_object_handle/lowest_layer_type.html" title="windows::basic_object_handle::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a>
90 An object handle is always the lowest layer.
97 <a class="link" href="windows__basic_object_handle/native_handle_type.html" title="windows::basic_object_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__basic_object_handle.h1"></a>
110 <span class="phrase"><a name="boost_asio.reference.windows__basic_object_handle.member_functions"></a></span><a class="link" href="windows__basic_object_handle.html#boost_asio.reference.windows__basic_object_handle.member_functions">Member
113 <div class="informaltable"><table class="table">
134 <a class="link" href="windows__basic_object_handle/assign.html" title="windows::basic_object_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_object_handle/async_wait.html" title="windows::basic_object_handle::async_wait"><span class="bold"><strong>async_wait</strong></span></a>
151 Start an asynchronous wait on the object handle.
158 <a class="link" href="windows__basic_object_handle/basic_object_handle.html" title="windows::basic_object_handle::basic_object_handle"><span class="bold"><strong>basic_object_handle</strong></span></a>
163 Construct an object handle without opening it. <br> <span class="silver"> —</span><br> Construct
164 an object handle on an existing native handle. <br> <span class="silver"> —</span><br> Move-construct
165 an object handle from another.
172 <a class="link" href="windows__basic_object_handle/cancel.html" title="windows::basic_object_handle::cancel"><span class="bold"><strong>cancel</strong></span></a>
177 Cancel all asynchronous operations associated with the handle.
184 <a class="link" href="windows__basic_object_handle/close.html" title="windows::basic_object_handle::close"><span class="bold"><strong>close</strong></span></a>
196 <a class="link" href="windows__basic_object_handle/get_executor.html" title="windows::basic_object_handle::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
201 Get the executor associated with the object.
208 <a class="link" href="windows__basic_object_handle/is_open.html" title="windows::basic_object_handle::is_open"><span class="bold"><strong>is_open</strong></span></a>
213 Determine whether the handle is open.
220 <a class="link" href="windows__basic_object_handle/lowest_layer.html" title="windows::basic_object_handle::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a>
225 Get a reference to the lowest layer. <br> <span class="silver"> —</span><br> Get a const
226 reference to the lowest layer.
233 <a class="link" href="windows__basic_object_handle/native_handle.html" title="windows::basic_object_handle::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
238 Get the native handle representation.
245 <a class="link" href="windows__basic_object_handle/operator_eq_.html" title="windows::basic_object_handle::operator="><span class="bold"><strong>operator=</strong></span></a>
250 Move-assign an object handle from another.
257 <a class="link" href="windows__basic_object_handle/wait.html" title="windows::basic_object_handle::wait"><span class="bold"><strong>wait</strong></span></a>
262 Perform a blocking wait on the object handle.
269 The <a class="link" href="windows__basic_object_handle.html" title="windows::basic_object_handle"><code class="computeroutput">windows::basic_object_handle</code></a>
270 class provides asynchronous and blocking object-oriented handle functionality.
273 <a name="boost_asio.reference.windows__basic_object_handle.h2"></a>
274 <span class="phrase"><a name="boost_asio.reference.windows__basic_object_handle.thread_safety"></a></span><a class="link" href="windows__basic_object_handle.html#boost_asio.reference.windows__basic_object_handle.thread_safety">Thread
278 <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
281 <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
284 <a name="boost_asio.reference.windows__basic_object_handle.h3"></a>
285 <span class="phrase"><a name="boost_asio.reference.windows__basic_object_handle.requirements"></a></span><a class="link" href="windows__basic_object_handle.html#boost_asio.reference.windows__basic_object_handle.requirements">Requirements</a>
288 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/basic_object_handle.hpp</code>
291 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
294 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
295 <td align="left"></td>
296 <td align="right"><div class="copyright-footer">Copyright © 2003-2019 Christopher M. Kohlhoff<p>
297 Distributed under the Boost Software License, Version 1.0. (See accompanying
298 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>)
303 <div class="spirit-nav">
304 <a accesskey="p" href="wait_traits/to_wait_duration/overload2.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_object_handle/assign.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>