doc/html/boost_asio/reference/windows__object_handle.html

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