doc/html/boost_asio/reference/windows__basic_random_access_handle.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>windows::basic_random_access_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_overlapped_handle__rebind_executor/other.html" title="windows::basic_overlapped_handle::rebind_executor::other">
  10 <link rel="next" href="windows__basic_random_access_handle/assign.html" title="windows::basic_random_access_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_overlapped_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_random_access_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_random_access_handle"></a><a class="link" href="windows__basic_random_access_handle.html" title="windows::basic_random_access_handle">windows::basic_random_access_handle</a>
  28 </h3></div></div></div>
  29 <p>
  30         Provides random-access handle functionality.
  31       </p>
  32 <pre class="programlisting">template&lt;
  33     typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a> = executor&gt;
  34 class basic_random_access_handle :
  35   public windows::basic_overlapped_handle&lt; Executor &gt;
  36 </pre>
  37 <h5>
  38 <a name="boost_asio.reference.windows__basic_random_access_handle.h0"></a>
  39         <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.types"></a></span><a class="link" href="windows__basic_random_access_handle.html#boost_asio.reference.windows__basic_random_access_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_random_access_handle__rebind_executor.html" title="windows::basic_random_access_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_random_access_handle/executor_type.html" title="windows::basic_random_access_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_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>
  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_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>
  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_random_access_handle.h1"></a>
 111         <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.member_functions"></a></span><a class="link" href="windows__basic_random_access_handle.html#boost_asio.reference.windows__basic_random_access_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_random_access_handle/assign.html" title="windows::basic_random_access_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_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>
 148                 </p>
 149               </td>
 150 <td>
 151                 <p>
 152                   Start an asynchronous read at the specified offset.
 153                 </p>
 154               </td>
 155 </tr>
 156 <tr>
 157 <td>
 158                 <p>
 159                   <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>
 160                 </p>
 161               </td>
 162 <td>
 163                 <p>
 164                   Start an asynchronous write at the specified offset.
 165                 </p>
 166               </td>
 167 </tr>
 168 <tr>
 169 <td>
 170                 <p>
 171                   <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>
 172                 </p>
 173               </td>
 174 <td>
 175                 <p>
 176                   Construct a random-access handle without opening it. <br> <span class="silver"> &#8212;</span><br>
 177                   Construct a random-access handle on an existing native handle.
 178                   <br> <span class="silver"> &#8212;</span><br> Move-construct a random-access handle from another.
 179                 </p>
 180               </td>
 181 </tr>
 182 <tr>
 183 <td>
 184                 <p>
 185                   <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>
 186                 </p>
 187               </td>
 188 <td>
 189                 <p>
 190                   Cancel all asynchronous operations associated with the handle.
 191                 </p>
 192               </td>
 193 </tr>
 194 <tr>
 195 <td>
 196                 <p>
 197                   <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>
 198                 </p>
 199               </td>
 200 <td>
 201                 <p>
 202                   Close the handle.
 203                 </p>
 204               </td>
 205 </tr>
 206 <tr>
 207 <td>
 208                 <p>
 209                   <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>
 210                 </p>
 211               </td>
 212 <td>
 213                 <p>
 214                   Get the executor associated with the object.
 215                 </p>
 216               </td>
 217 </tr>
 218 <tr>
 219 <td>
 220                 <p>
 221                   <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>
 222                 </p>
 223               </td>
 224 <td>
 225                 <p>
 226                   Determine whether the handle is open.
 227                 </p>
 228               </td>
 229 </tr>
 230 <tr>
 231 <td>
 232                 <p>
 233                   <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>
 234                 </p>
 235               </td>
 236 <td>
 237                 <p>
 238                   Get a reference to the lowest layer. <br> <span class="silver"> &#8212;</span><br> Get a const
 239                   reference to the lowest layer.
 240                 </p>
 241               </td>
 242 </tr>
 243 <tr>
 244 <td>
 245                 <p>
 246                   <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>
 247                 </p>
 248               </td>
 249 <td>
 250                 <p>
 251                   Get the native handle representation.
 252                 </p>
 253               </td>
 254 </tr>
 255 <tr>
 256 <td>
 257                 <p>
 258                   <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>
 259                 </p>
 260               </td>
 261 <td>
 262                 <p>
 263                   Move-assign a random-access handle from another.
 264                 </p>
 265               </td>
 266 </tr>
 267 <tr>
 268 <td>
 269                 <p>
 270                   <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>
 271                 </p>
 272               </td>
 273 <td>
 274                 <p>
 275                   Read some data from the handle at the specified offset.
 276                 </p>
 277               </td>
 278 </tr>
 279 <tr>
 280 <td>
 281                 <p>
 282                   <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>
 283                 </p>
 284               </td>
 285 <td>
 286                 <p>
 287                   Write some data to the handle at the specified offset.
 288                 </p>
 289               </td>
 290 </tr>
 291 </tbody>
 292 </table></div>
 293 <h5>
 294 <a name="boost_asio.reference.windows__basic_random_access_handle.h2"></a>
 295         <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.protected_data_members"></a></span><a class="link" href="windows__basic_random_access_handle.html#boost_asio.reference.windows__basic_random_access_handle.protected_data_members">Protected
 296         Data Members</a>
 297       </h5>
 298 <div class="informaltable"><table class="table">
 299 <colgroup>
 300 <col>
 301 <col>
 302 </colgroup>
 303 <thead><tr>
 304 <th>
 305                 <p>
 306                   Name
 307                 </p>
 308               </th>
 309 <th>
 310                 <p>
 311                   Description
 312                 </p>
 313               </th>
 314 </tr></thead>
 315 <tbody><tr>
 316 <td>
 317                 <p>
 318                   <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>
 319                 </p>
 320               </td>
 321 <td>
 322               </td>
 323 </tr></tbody>
 324 </table></div>
 325 <p>
 326         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>
 327         class provides asynchronous and blocking random-access handle functionality.
 328       </p>
 329 <h5>
 330 <a name="boost_asio.reference.windows__basic_random_access_handle.h3"></a>
 331         <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.thread_safety"></a></span><a class="link" href="windows__basic_random_access_handle.html#boost_asio.reference.windows__basic_random_access_handle.thread_safety">Thread
 332         Safety</a>
 333       </h5>
 334 <p>
 335         <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
 336       </p>
 337 <p>
 338         <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
 339       </p>
 340 <h5>
 341 <a name="boost_asio.reference.windows__basic_random_access_handle.h4"></a>
 342         <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.requirements"></a></span><a class="link" href="windows__basic_random_access_handle.html#boost_asio.reference.windows__basic_random_access_handle.requirements">Requirements</a>
 343       </h5>
 344 <p>
 345         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/basic_random_access_handle.hpp</code>
 346       </p>
 347 <p>
 348         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 349       </p>
 350 </div>
 351 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 352 <td align="left"></td>
 353 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
 354         Distributed under the Boost Software License, Version 1.0. (See accompanying
 355         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>)
 356       </p>
 357 </div></td>
 358 </tr></table>
 359 <hr>
 360 <div class="spirit-nav">
 361 <a accesskey="p" href="windows__basic_overlapped_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_random_access_handle/assign.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 362 </div>
 363 </body>
 364 </html>