doc/html/boost_asio/reference/windows__object_handle_service.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>windows::object_handle_service</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.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__object_handle.html" title="windows::object_handle">
  10 <link rel="next" href="windows__object_handle_service/assign.html" title="windows::object_handle_service::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__object_handle.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/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__object_handle_service"></a><a class="link" href="windows__object_handle_service.html" title="windows::object_handle_service">windows::object_handle_service</a>
  28 </h3></div></div></div>
  29 <p>
  30         Default service implementation for an object handle.
  31       </p>
  32 <pre class="programlisting"><span class="keyword">class</span> <span class="identifier">object_handle_service</span> <span class="special">:</span>
  33   <span class="keyword">public</span> <span class="identifier">io_service</span><span class="special">::</span><span class="identifier">service</span>
  34 </pre>
  35 <h5>
  36 <a name="boost_asio.reference.windows__object_handle_service.h0"></a>
  37         <span><a name="boost_asio.reference.windows__object_handle_service.types"></a></span><a class="link" href="windows__object_handle_service.html#boost_asio.reference.windows__object_handle_service.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__object_handle_service/implementation_type.html" title="windows::object_handle_service::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a>
  61                 </p>
  62               </td>
  63 <td>
  64                 <p>
  65                   The type of an object handle implementation.
  66                 </p>
  67               </td>
  68 </tr>
  69 <tr>
  70 <td>
  71                 <p>
  72                   <a class="link" href="windows__object_handle_service/native_handle_type.html" title="windows::object_handle_service::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a>
  73                 </p>
  74               </td>
  75 <td>
  76                 <p>
  77                   The native handle type.
  78                 </p>
  79               </td>
  80 </tr>
  81 </tbody>
  82 </table></div>
  83 <h5>
  84 <a name="boost_asio.reference.windows__object_handle_service.h1"></a>
  85         <span><a name="boost_asio.reference.windows__object_handle_service.member_functions"></a></span><a class="link" href="windows__object_handle_service.html#boost_asio.reference.windows__object_handle_service.member_functions">Member
  86         Functions</a>
  87       </h5>
  88 <div class="informaltable"><table class="table">
  89 <colgroup>
  90 <col>
  91 <col>
  92 </colgroup>
  93 <thead><tr>
  94 <th>
  95                 <p>
  96                   Name
  97                 </p>
  98               </th>
  99 <th>
 100                 <p>
 101                   Description
 102                 </p>
 103               </th>
 104 </tr></thead>
 105 <tbody>
 106 <tr>
 107 <td>
 108                 <p>
 109                   <a class="link" href="windows__object_handle_service/assign.html" title="windows::object_handle_service::assign"><span class="bold"><strong>assign</strong></span></a>
 110                 </p>
 111               </td>
 112 <td>
 113                 <p>
 114                   Assign an existing native handle to an object handle.
 115                 </p>
 116               </td>
 117 </tr>
 118 <tr>
 119 <td>
 120                 <p>
 121                   <a class="link" href="windows__object_handle_service/async_wait.html" title="windows::object_handle_service::async_wait"><span class="bold"><strong>async_wait</strong></span></a>
 122                 </p>
 123               </td>
 124 <td>
 125                 <p>
 126                   Start an asynchronous wait.
 127                 </p>
 128               </td>
 129 </tr>
 130 <tr>
 131 <td>
 132                 <p>
 133                   <a class="link" href="windows__object_handle_service/cancel.html" title="windows::object_handle_service::cancel"><span class="bold"><strong>cancel</strong></span></a>
 134                 </p>
 135               </td>
 136 <td>
 137                 <p>
 138                   Cancel all asynchronous operations associated with the handle.
 139                 </p>
 140               </td>
 141 </tr>
 142 <tr>
 143 <td>
 144                 <p>
 145                   <a class="link" href="windows__object_handle_service/close.html" title="windows::object_handle_service::close"><span class="bold"><strong>close</strong></span></a>
 146                 </p>
 147               </td>
 148 <td>
 149                 <p>
 150                   Close an object handle implementation.
 151                 </p>
 152               </td>
 153 </tr>
 154 <tr>
 155 <td>
 156                 <p>
 157                   <a class="link" href="windows__object_handle_service/construct.html" title="windows::object_handle_service::construct"><span class="bold"><strong>construct</strong></span></a>
 158                 </p>
 159               </td>
 160 <td>
 161                 <p>
 162                   Construct a new object handle implementation.
 163                 </p>
 164               </td>
 165 </tr>
 166 <tr>
 167 <td>
 168                 <p>
 169                   <a class="link" href="windows__object_handle_service/destroy.html" title="windows::object_handle_service::destroy"><span class="bold"><strong>destroy</strong></span></a>
 170                 </p>
 171               </td>
 172 <td>
 173                 <p>
 174                   Destroy an object handle implementation.
 175                 </p>
 176               </td>
 177 </tr>
 178 <tr>
 179 <td>
 180                 <p>
 181                   <a class="link" href="windows__object_handle_service/get_io_service.html" title="windows::object_handle_service::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
 182                 </p>
 183               </td>
 184 <td>
 185                 <p>
 186                   Get the io_service object that owns the service.
 187                 </p>
 188               </td>
 189 </tr>
 190 <tr>
 191 <td>
 192                 <p>
 193                   <a class="link" href="windows__object_handle_service/is_open.html" title="windows::object_handle_service::is_open"><span class="bold"><strong>is_open</strong></span></a>
 194                 </p>
 195               </td>
 196 <td>
 197                 <p>
 198                   Determine whether the handle is open.
 199                 </p>
 200               </td>
 201 </tr>
 202 <tr>
 203 <td>
 204                 <p>
 205                   <a class="link" href="windows__object_handle_service/move_assign.html" title="windows::object_handle_service::move_assign"><span class="bold"><strong>move_assign</strong></span></a>
 206                 </p>
 207               </td>
 208 <td>
 209                 <p>
 210                   Move-assign from another object handle implementation.
 211                 </p>
 212               </td>
 213 </tr>
 214 <tr>
 215 <td>
 216                 <p>
 217                   <a class="link" href="windows__object_handle_service/move_construct.html" title="windows::object_handle_service::move_construct"><span class="bold"><strong>move_construct</strong></span></a>
 218                 </p>
 219               </td>
 220 <td>
 221                 <p>
 222                   Move-construct a new object handle implementation.
 223                 </p>
 224               </td>
 225 </tr>
 226 <tr>
 227 <td>
 228                 <p>
 229                   <a class="link" href="windows__object_handle_service/native_handle.html" title="windows::object_handle_service::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
 230                 </p>
 231               </td>
 232 <td>
 233                 <p>
 234                   Get the native handle implementation.
 235                 </p>
 236               </td>
 237 </tr>
 238 <tr>
 239 <td>
 240                 <p>
 241                   <a class="link" href="windows__object_handle_service/object_handle_service.html" title="windows::object_handle_service::object_handle_service"><span class="bold"><strong>object_handle_service</strong></span></a>
 242                 </p>
 243               </td>
 244 <td>
 245                 <p>
 246                   Construct a new object handle service for the specified io_service.
 247                 </p>
 248               </td>
 249 </tr>
 250 <tr>
 251 <td>
 252                 <p>
 253                   <a class="link" href="windows__object_handle_service/wait.html" title="windows::object_handle_service::wait"><span class="bold"><strong>wait</strong></span></a>
 254                 </p>
 255               </td>
 256 <td>
 257               </td>
 258 </tr>
 259 </tbody>
 260 </table></div>
 261 <h5>
 262 <a name="boost_asio.reference.windows__object_handle_service.h2"></a>
 263         <span><a name="boost_asio.reference.windows__object_handle_service.data_members"></a></span><a class="link" href="windows__object_handle_service.html#boost_asio.reference.windows__object_handle_service.data_members">Data
 264         Members</a>
 265       </h5>
 266 <div class="informaltable"><table class="table">
 267 <colgroup>
 268 <col>
 269 <col>
 270 </colgroup>
 271 <thead><tr>
 272 <th>
 273                 <p>
 274                   Name
 275                 </p>
 276               </th>
 277 <th>
 278                 <p>
 279                   Description
 280                 </p>
 281               </th>
 282 </tr></thead>
 283 <tbody><tr>
 284 <td>
 285                 <p>
 286                   <a class="link" href="windows__object_handle_service/id.html" title="windows::object_handle_service::id"><span class="bold"><strong>id</strong></span></a>
 287                 </p>
 288               </td>
 289 <td>
 290                 <p>
 291                   The unique service identifier.
 292                 </p>
 293               </td>
 294 </tr></tbody>
 295 </table></div>
 296 <h5>
 297 <a name="boost_asio.reference.windows__object_handle_service.h3"></a>
 298         <span><a name="boost_asio.reference.windows__object_handle_service.requirements"></a></span><a class="link" href="windows__object_handle_service.html#boost_asio.reference.windows__object_handle_service.requirements">Requirements</a>
 299       </h5>
 300 <p>
 301         <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/windows/object_handle_service.hpp</code>
 302       </p>
 303 <p>
 304         <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code>
 305       </p>
 306 </div>
 307 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 308 <td align="left"></td>
 309 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2012 Christopher M. Kohlhoff<p>
 310         Distributed under the Boost Software License, Version 1.0. (See accompanying
 311         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>)
 312       </p>
 313 </div></td>
 314 </tr></table>
 315 <hr>
 316 <div class="spirit-nav">
 317 <a accesskey="p" href="windows__object_handle.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/assign.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 318 </div>
 319 </body>
 320 </html>