doc/html/boost_asio/reference/windows__random_access_handle.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>windows::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.78.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__overlapped_ptr/_overlapped_ptr.html" title="windows::overlapped_ptr::~overlapped_ptr">
  10 <link rel="next" href="windows__random_access_handle_service.html" title="windows::random_access_handle_service">
  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__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_service.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__random_access_handle"></a><a class="link" href="windows__random_access_handle.html" title="windows::random_access_handle">windows::random_access_handle</a>
  28 </h3></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idp204937904"></a>
  31 Typedef for the typical usage of a random-access
  32         handle.
  33       </p>
  34 <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">basic_random_access_handle</span> <span class="identifier">random_access_handle</span><span class="special">;</span>
  35 </pre>
  36 <h5>
  37 <a name="boost_asio.reference.windows__random_access_handle.h0"></a>
  38         <span class="phrase"><a name="boost_asio.reference.windows__random_access_handle.types"></a></span><a class="link" href="windows__random_access_handle.html#boost_asio.reference.windows__random_access_handle.types">Types</a>
  39       </h5>
  40 <div class="informaltable"><table class="table">
  41 <colgroup>
  42 <col>
  43 <col>
  44 </colgroup>
  45 <thead><tr>
  46 <th>
  47                 <p>
  48                   Name
  49                 </p>
  50               </th>
  51 <th>
  52                 <p>
  53                   Description
  54                 </p>
  55               </th>
  56 </tr></thead>
  57 <tbody>
  58 <tr>
  59 <td>
  60                 <p>
  61                   <a class="link" href="windows__basic_random_access_handle/implementation_type.html" title="windows::basic_random_access_handle::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a>
  62                 </p>
  63               </td>
  64 <td>
  65                 <p>
  66                   The underlying implementation type of I/O object.
  67                 </p>
  68               </td>
  69 </tr>
  70 <tr>
  71 <td>
  72                 <p>
  73                   <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>
  74                 </p>
  75               </td>
  76 <td>
  77                 <p>
  78                   A basic_handle is always the lowest layer.
  79                 </p>
  80               </td>
  81 </tr>
  82 <tr>
  83 <td>
  84                 <p>
  85                   <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>
  86                 </p>
  87               </td>
  88 <td>
  89                 <p>
  90                   The native representation of a handle.
  91                 </p>
  92               </td>
  93 </tr>
  94 <tr>
  95 <td>
  96                 <p>
  97                   <a class="link" href="windows__basic_random_access_handle/native_type.html" title="windows::basic_random_access_handle::native_type"><span class="bold"><strong>native_type</strong></span></a>
  98                 </p>
  99               </td>
 100 <td>
 101                 <p>
 102                   (Deprecated: Use native_handle_type.) The native representation
 103                   of a handle.
 104                 </p>
 105               </td>
 106 </tr>
 107 <tr>
 108 <td>
 109                 <p>
 110                   <a class="link" href="windows__basic_random_access_handle/service_type.html" title="windows::basic_random_access_handle::service_type"><span class="bold"><strong>service_type</strong></span></a>
 111                 </p>
 112               </td>
 113 <td>
 114                 <p>
 115                   The type of the service that will be used to provide I/O operations.
 116                 </p>
 117               </td>
 118 </tr>
 119 </tbody>
 120 </table></div>
 121 <h5>
 122 <a name="boost_asio.reference.windows__random_access_handle.h1"></a>
 123         <span class="phrase"><a name="boost_asio.reference.windows__random_access_handle.member_functions"></a></span><a class="link" href="windows__random_access_handle.html#boost_asio.reference.windows__random_access_handle.member_functions">Member
 124         Functions</a>
 125       </h5>
 126 <div class="informaltable"><table class="table">
 127 <colgroup>
 128 <col>
 129 <col>
 130 </colgroup>
 131 <thead><tr>
 132 <th>
 133                 <p>
 134                   Name
 135                 </p>
 136               </th>
 137 <th>
 138                 <p>
 139                   Description
 140                 </p>
 141               </th>
 142 </tr></thead>
 143 <tbody>
 144 <tr>
 145 <td>
 146                 <p>
 147                   <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>
 148                 </p>
 149               </td>
 150 <td>
 151                 <p>
 152                   Assign an existing native handle to the handle.
 153                 </p>
 154               </td>
 155 </tr>
 156 <tr>
 157 <td>
 158                 <p>
 159                   <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>
 160                 </p>
 161               </td>
 162 <td>
 163                 <p>
 164                   Start an asynchronous read 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/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>
 172                 </p>
 173               </td>
 174 <td>
 175                 <p>
 176                   Start an asynchronous write at the specified offset.
 177                 </p>
 178               </td>
 179 </tr>
 180 <tr>
 181 <td>
 182                 <p>
 183                   <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>
 184                 </p>
 185               </td>
 186 <td>
 187                 <p>
 188                   Construct a basic_random_access_handle without opening it.
 189                 </p>
 190                 <p>
 191                   Construct a basic_random_access_handle on an existing native handle.
 192                 </p>
 193                 <p>
 194                   Move-construct a basic_random_access_handle from another.
 195                 </p>
 196               </td>
 197 </tr>
 198 <tr>
 199 <td>
 200                 <p>
 201                   <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>
 202                 </p>
 203               </td>
 204 <td>
 205                 <p>
 206                   Cancel all asynchronous operations associated with the handle.
 207                 </p>
 208               </td>
 209 </tr>
 210 <tr>
 211 <td>
 212                 <p>
 213                   <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>
 214                 </p>
 215               </td>
 216 <td>
 217                 <p>
 218                   Close the handle.
 219                 </p>
 220               </td>
 221 </tr>
 222 <tr>
 223 <td>
 224                 <p>
 225                   <a class="link" href="windows__basic_random_access_handle/get_io_service.html" title="windows::basic_random_access_handle::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
 226                 </p>
 227               </td>
 228 <td>
 229                 <p>
 230                   Get the io_service associated with the object.
 231                 </p>
 232               </td>
 233 </tr>
 234 <tr>
 235 <td>
 236                 <p>
 237                   <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>
 238                 </p>
 239               </td>
 240 <td>
 241                 <p>
 242                   Determine whether the handle is open.
 243                 </p>
 244               </td>
 245 </tr>
 246 <tr>
 247 <td>
 248                 <p>
 249                   <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>
 250                 </p>
 251               </td>
 252 <td>
 253                 <p>
 254                   Get a reference to the lowest layer.
 255                 </p>
 256                 <p>
 257                   Get a const reference to the lowest layer.
 258                 </p>
 259               </td>
 260 </tr>
 261 <tr>
 262 <td>
 263                 <p>
 264                   <a class="link" href="windows__basic_random_access_handle/native.html" title="windows::basic_random_access_handle::native"><span class="bold"><strong>native</strong></span></a>
 265                 </p>
 266               </td>
 267 <td>
 268                 <p>
 269                   (Deprecated: Use native_handle().) Get the native handle representation.
 270                 </p>
 271               </td>
 272 </tr>
 273 <tr>
 274 <td>
 275                 <p>
 276                   <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>
 277                 </p>
 278               </td>
 279 <td>
 280                 <p>
 281                   Get the native handle representation.
 282                 </p>
 283               </td>
 284 </tr>
 285 <tr>
 286 <td>
 287                 <p>
 288                   <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>
 289                 </p>
 290               </td>
 291 <td>
 292                 <p>
 293                   Move-assign a basic_random_access_handle from another.
 294                 </p>
 295               </td>
 296 </tr>
 297 <tr>
 298 <td>
 299                 <p>
 300                   <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>
 301                 </p>
 302               </td>
 303 <td>
 304                 <p>
 305                   Read some data from the handle at the specified offset.
 306                 </p>
 307               </td>
 308 </tr>
 309 <tr>
 310 <td>
 311                 <p>
 312                   <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>
 313                 </p>
 314               </td>
 315 <td>
 316                 <p>
 317                   Write some data to the handle at the specified offset.
 318                 </p>
 319               </td>
 320 </tr>
 321 </tbody>
 322 </table></div>
 323 <h5>
 324 <a name="boost_asio.reference.windows__random_access_handle.h2"></a>
 325         <span class="phrase"><a name="boost_asio.reference.windows__random_access_handle.protected_member_functions"></a></span><a class="link" href="windows__random_access_handle.html#boost_asio.reference.windows__random_access_handle.protected_member_functions">Protected
 326         Member Functions</a>
 327       </h5>
 328 <div class="informaltable"><table class="table">
 329 <colgroup>
 330 <col>
 331 <col>
 332 </colgroup>
 333 <thead><tr>
 334 <th>
 335                 <p>
 336                   Name
 337                 </p>
 338               </th>
 339 <th>
 340                 <p>
 341                   Description
 342                 </p>
 343               </th>
 344 </tr></thead>
 345 <tbody>
 346 <tr>
 347 <td>
 348                 <p>
 349                   <a class="link" href="windows__basic_random_access_handle/get_implementation.html" title="windows::basic_random_access_handle::get_implementation"><span class="bold"><strong>get_implementation</strong></span></a>
 350                 </p>
 351               </td>
 352 <td>
 353                 <p>
 354                   Get the underlying implementation of the I/O object.
 355                 </p>
 356               </td>
 357 </tr>
 358 <tr>
 359 <td>
 360                 <p>
 361                   <a class="link" href="windows__basic_random_access_handle/get_service.html" title="windows::basic_random_access_handle::get_service"><span class="bold"><strong>get_service</strong></span></a>
 362                 </p>
 363               </td>
 364 <td>
 365                 <p>
 366                   Get the service associated with the I/O object.
 367                 </p>
 368               </td>
 369 </tr>
 370 </tbody>
 371 </table></div>
 372 <h5>
 373 <a name="boost_asio.reference.windows__random_access_handle.h3"></a>
 374         <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
 375         Data Members</a>
 376       </h5>
 377 <div class="informaltable"><table class="table">
 378 <colgroup>
 379 <col>
 380 <col>
 381 </colgroup>
 382 <thead><tr>
 383 <th>
 384                 <p>
 385                   Name
 386                 </p>
 387               </th>
 388 <th>
 389                 <p>
 390                   Description
 391                 </p>
 392               </th>
 393 </tr></thead>
 394 <tbody>
 395 <tr>
 396 <td>
 397                 <p>
 398                   <a class="link" href="windows__basic_random_access_handle/implementation.html" title="windows::basic_random_access_handle::implementation"><span class="bold"><strong>implementation</strong></span></a>
 399                 </p>
 400               </td>
 401 <td>
 402                 <p>
 403                   (Deprecated: Use get_implementation().) The underlying implementation
 404                   of the I/O object.
 405                 </p>
 406               </td>
 407 </tr>
 408 <tr>
 409 <td>
 410                 <p>
 411                   <a class="link" href="windows__basic_random_access_handle/service.html" title="windows::basic_random_access_handle::service"><span class="bold"><strong>service</strong></span></a>
 412                 </p>
 413               </td>
 414 <td>
 415                 <p>
 416                   (Deprecated: Use get_service().) The service associated with the
 417                   I/O object.
 418                 </p>
 419               </td>
 420 </tr>
 421 </tbody>
 422 </table></div>
 423 <p>
 424         The <a class="link" href="windows__basic_random_access_handle.html" title="windows::basic_random_access_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_random_access_handle</span></code></a> class
 425         template provides asynchronous and blocking random-access handle functionality.
 426       </p>
 427 <h5>
 428 <a name="boost_asio.reference.windows__random_access_handle.h4"></a>
 429         <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
 430         Safety</a>
 431       </h5>
 432 <p>
 433         <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
 434       </p>
 435 <p>
 436         <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
 437       </p>
 438 <h5>
 439 <a name="boost_asio.reference.windows__random_access_handle.h5"></a>
 440         <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>
 441       </h5>
 442 <p>
 443         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/random_access_handle.hpp</code>
 444       </p>
 445 <p>
 446         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 447       </p>
 448 </div>
 449 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 450 <td align="left"></td>
 451 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
 452         Distributed under the Boost Software License, Version 1.0. (See accompanying
 453         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>)
 454       </p>
 455 </div></td>
 456 </tr></table>
 457 <hr>
 458 <div class="spirit-nav">
 459 <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_service.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 460 </div>
 461 </body>
 462 </html>