summaryrefslogtreecommitdiff
path: root/doc/html/boost_asio/reference/windows__random_access_handle.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/boost_asio/reference/windows__random_access_handle.html')
-rw-r--r--doc/html/boost_asio/reference/windows__random_access_handle.html119
1 files changed, 63 insertions, 56 deletions
diff --git a/doc/html/boost_asio/reference/windows__random_access_handle.html b/doc/html/boost_asio/reference/windows__random_access_handle.html
index 7c111391dd..b0e2af5430 100644
--- a/doc/html/boost_asio/reference/windows__random_access_handle.html
+++ b/doc/html/boost_asio/reference/windows__random_access_handle.html
@@ -7,7 +7,7 @@
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="windows__overlapped_ptr/_overlapped_ptr.html" title="windows::overlapped_ptr::~overlapped_ptr">
-<link rel="next" href="windows__random_access_handle/assign.html" title="windows::random_access_handle::assign">
+<link rel="next" href="windows__stream_handle.html" title="windows::stream_handle">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -20,17 +20,18 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="windows__overlapped_ptr/_overlapped_ptr.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__random_access_handle/assign.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="windows__overlapped_ptr/_overlapped_ptr.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__stream_handle.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_asio.reference.windows__random_access_handle"></a><a class="link" href="windows__random_access_handle.html" title="windows::random_access_handle">windows::random_access_handle</a>
</h3></div></div></div>
<p>
- Provides random-access handle functionality.
+ <a class="indexterm" name="boost_asio.indexterm.windows__random_access_handle"></a>
+Typedef
+ for the typical usage of a random-access handle.
</p>
-<pre class="programlisting">class random_access_handle :
- public windows::overlapped_handle
+<pre class="programlisting">typedef basic_random_access_handle random_access_handle;
</pre>
<h5>
<a name="boost_asio.reference.windows__random_access_handle.h0"></a>
@@ -57,7 +58,7 @@
<tr>
<td>
<p>
- <a class="link" href="windows__random_access_handle/executor_type.html" title="windows::random_access_handle::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
+ <a class="link" href="windows__basic_random_access_handle/executor_type.html" title="windows::basic_random_access_handle::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
</p>
</td>
<td>
@@ -69,7 +70,7 @@
<tr>
<td>
<p>
- <a class="link" href="windows__random_access_handle/lowest_layer_type.html" title="windows::random_access_handle::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a>
+ <a class="link" href="windows__basic_random_access_handle/lowest_layer_type.html" title="windows::basic_random_access_handle::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a>
</p>
</td>
<td>
@@ -81,7 +82,7 @@
<tr>
<td>
<p>
- <a class="link" href="windows__random_access_handle/native_handle_type.html" title="windows::random_access_handle::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a>
+ <a class="link" href="windows__basic_random_access_handle/native_handle_type.html" title="windows::basic_random_access_handle::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a>
</p>
</td>
<td>
@@ -118,7 +119,7 @@
<tr>
<td>
<p>
- <a class="link" href="windows__random_access_handle/assign.html" title="windows::random_access_handle::assign"><span class="bold"><strong>assign</strong></span></a>
+ <a class="link" href="windows__basic_random_access_handle/assign.html" title="windows::basic_random_access_handle::assign"><span class="bold"><strong>assign</strong></span></a>
</p>
</td>
<td>
@@ -130,7 +131,7 @@
<tr>
<td>
<p>
- <a class="link" href="windows__random_access_handle/async_read_some_at.html" title="windows::random_access_handle::async_read_some_at"><span class="bold"><strong>async_read_some_at</strong></span></a>
+ <a class="link" href="windows__basic_random_access_handle/async_read_some_at.html" title="windows::basic_random_access_handle::async_read_some_at"><span class="bold"><strong>async_read_some_at</strong></span></a>
</p>
</td>
<td>
@@ -142,7 +143,7 @@
<tr>
<td>
<p>
- <a class="link" href="windows__random_access_handle/async_write_some_at.html" title="windows::random_access_handle::async_write_some_at"><span class="bold"><strong>async_write_some_at</strong></span></a>
+ <a class="link" href="windows__basic_random_access_handle/async_write_some_at.html" title="windows::basic_random_access_handle::async_write_some_at"><span class="bold"><strong>async_write_some_at</strong></span></a>
</p>
</td>
<td>
@@ -154,69 +155,57 @@
<tr>
<td>
<p>
- <a class="link" href="windows__random_access_handle/cancel.html" title="windows::random_access_handle::cancel"><span class="bold"><strong>cancel</strong></span></a>
+ <a class="link" href="windows__basic_random_access_handle/basic_random_access_handle.html" title="windows::basic_random_access_handle::basic_random_access_handle"><span class="bold"><strong>basic_random_access_handle</strong></span></a>
</p>
</td>
<td>
<p>
- Cancel all asynchronous operations associated with the handle.
+ Construct a random-access handle without opening it. <br> <span class="silver"> &#8212;</span><br>
+ Construct a random-access handle on an existing native handle.
+ <br> <span class="silver"> &#8212;</span><br> Move-construct a random-access handle from another.
</p>
</td>
</tr>
<tr>
<td>
<p>
- <a class="link" href="windows__random_access_handle/close.html" title="windows::random_access_handle::close"><span class="bold"><strong>close</strong></span></a>
+ <a class="link" href="windows__basic_random_access_handle/cancel.html" title="windows::basic_random_access_handle::cancel"><span class="bold"><strong>cancel</strong></span></a>
</p>
</td>
<td>
<p>
- Close the handle.
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <a class="link" href="windows__random_access_handle/get_executor.html" title="windows::random_access_handle::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
- </p>
- </td>
-<td>
- <p>
- Get the executor associated with the object.
+ Cancel all asynchronous operations associated with the handle.
</p>
</td>
</tr>
<tr>
<td>
<p>
- <a class="link" href="windows__random_access_handle/get_io_context.html" title="windows::random_access_handle::get_io_context"><span class="bold"><strong>get_io_context</strong></span></a>
+ <a class="link" href="windows__basic_random_access_handle/close.html" title="windows::basic_random_access_handle::close"><span class="bold"><strong>close</strong></span></a>
</p>
</td>
<td>
<p>
- (Deprecated: Use get_executor().) Get the io_context associated
- with the object.
+ Close the handle.
</p>
</td>
</tr>
<tr>
<td>
<p>
- <a class="link" href="windows__random_access_handle/get_io_service.html" title="windows::random_access_handle::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
+ <a class="link" href="windows__basic_random_access_handle/get_executor.html" title="windows::basic_random_access_handle::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
</p>
</td>
<td>
<p>
- (Deprecated: Use get_executor().) Get the io_context associated
- with the object.
+ Get the executor associated with the object.
</p>
</td>
</tr>
<tr>
<td>
<p>
- <a class="link" href="windows__random_access_handle/is_open.html" title="windows::random_access_handle::is_open"><span class="bold"><strong>is_open</strong></span></a>
+ <a class="link" href="windows__basic_random_access_handle/is_open.html" title="windows::basic_random_access_handle::is_open"><span class="bold"><strong>is_open</strong></span></a>
</p>
</td>
<td>
@@ -228,7 +217,7 @@
<tr>
<td>
<p>
- <a class="link" href="windows__random_access_handle/lowest_layer.html" title="windows::random_access_handle::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a>
+ <a class="link" href="windows__basic_random_access_handle/lowest_layer.html" title="windows::basic_random_access_handle::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a>
</p>
</td>
<td>
@@ -241,7 +230,7 @@
<tr>
<td>
<p>
- <a class="link" href="windows__random_access_handle/native_handle.html" title="windows::random_access_handle::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
+ <a class="link" href="windows__basic_random_access_handle/native_handle.html" title="windows::basic_random_access_handle::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
</p>
</td>
<td>
@@ -253,61 +242,79 @@
<tr>
<td>
<p>
- <a class="link" href="windows__random_access_handle/operator_eq_.html" title="windows::random_access_handle::operator="><span class="bold"><strong>operator=</strong></span></a>
+ <a class="link" href="windows__basic_random_access_handle/operator_eq_.html" title="windows::basic_random_access_handle::operator="><span class="bold"><strong>operator=</strong></span></a>
</p>
</td>
<td>
<p>
- Move-assign a random_access_handle from another.
+ Move-assign a random-access handle from another.
</p>
</td>
</tr>
<tr>
<td>
<p>
- <a class="link" href="windows__random_access_handle/random_access_handle.html" title="windows::random_access_handle::random_access_handle"><span class="bold"><strong>random_access_handle</strong></span></a>
+ <a class="link" href="windows__basic_random_access_handle/read_some_at.html" title="windows::basic_random_access_handle::read_some_at"><span class="bold"><strong>read_some_at</strong></span></a>
</p>
</td>
<td>
<p>
- Construct a random_access_handle without opening it. <br> <span class="silver"> &#8212;</span><br>
- Construct a random_access_handle on an existing native handle.
- <br> <span class="silver"> &#8212;</span><br> Move-construct a random_access_handle from another.
+ Read some data from the handle at the specified offset.
</p>
</td>
</tr>
<tr>
<td>
<p>
- <a class="link" href="windows__random_access_handle/read_some_at.html" title="windows::random_access_handle::read_some_at"><span class="bold"><strong>read_some_at</strong></span></a>
+ <a class="link" href="windows__basic_random_access_handle/write_some_at.html" title="windows::basic_random_access_handle::write_some_at"><span class="bold"><strong>write_some_at</strong></span></a>
</p>
</td>
<td>
<p>
- Read some data from the handle at the specified offset.
+ Write some data to the handle at the specified offset.
</p>
</td>
</tr>
-<tr>
-<td>
+</tbody>
+</table></div>
+<h5>
+<a name="boost_asio.reference.windows__random_access_handle.h2"></a>
+ <span class="phrase"><a name="boost_asio.reference.windows__random_access_handle.protected_data_members"></a></span><a class="link" href="windows__random_access_handle.html#boost_asio.reference.windows__random_access_handle.protected_data_members">Protected
+ Data Members</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
<p>
- <a class="link" href="windows__random_access_handle/write_some_at.html" title="windows::random_access_handle::write_some_at"><span class="bold"><strong>write_some_at</strong></span></a>
+ Name
</p>
- </td>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
<td>
<p>
- Write some data to the handle at the specified offset.
+ <a class="link" href="windows__basic_random_access_handle/impl_.html" title="windows::basic_random_access_handle::impl_"><span class="bold"><strong>impl_</strong></span></a>
</p>
</td>
-</tr>
-</tbody>
+<td>
+ </td>
+</tr></tbody>
</table></div>
<p>
- The <a class="link" href="windows__random_access_handle.html" title="windows::random_access_handle"><code class="computeroutput">windows::random_access_handle</code></a>
+ The <a class="link" href="windows__basic_random_access_handle.html" title="windows::basic_random_access_handle"><code class="computeroutput">windows::basic_random_access_handle</code></a>
class provides asynchronous and blocking random-access handle functionality.
</p>
<h5>
-<a name="boost_asio.reference.windows__random_access_handle.h2"></a>
+<a name="boost_asio.reference.windows__random_access_handle.h3"></a>
<span class="phrase"><a name="boost_asio.reference.windows__random_access_handle.thread_safety"></a></span><a class="link" href="windows__random_access_handle.html#boost_asio.reference.windows__random_access_handle.thread_safety">Thread
Safety</a>
</h5>
@@ -318,7 +325,7 @@
<span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
</p>
<h5>
-<a name="boost_asio.reference.windows__random_access_handle.h3"></a>
+<a name="boost_asio.reference.windows__random_access_handle.h4"></a>
<span class="phrase"><a name="boost_asio.reference.windows__random_access_handle.requirements"></a></span><a class="link" href="windows__random_access_handle.html#boost_asio.reference.windows__random_access_handle.requirements">Requirements</a>
</h5>
<p>
@@ -330,7 +337,7 @@
</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 &#169; 2003-2018 Christopher M. Kohlhoff<p>
+<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 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>
@@ -338,7 +345,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="windows__overlapped_ptr/_overlapped_ptr.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__random_access_handle/assign.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="windows__overlapped_ptr/_overlapped_ptr.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__stream_handle.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>