doc/html/boost_asio/reference/windows__basic_handle/lowest_layer_type.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>windows::basic_handle::lowest_layer_type</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="../windows__basic_handle.html" title="windows::basic_handle">
   9 <link rel="prev" href="lowest_layer/overload2.html" title="windows::basic_handle::lowest_layer (2 of 2 overloads)">
  10 <link rel="next" href="native.html" title="windows::basic_handle::native">
  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="lowest_layer/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_handle.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="native.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="boost_asio.reference.windows__basic_handle.lowest_layer_type"></a><a class="link" href="lowest_layer_type.html" title="windows::basic_handle::lowest_layer_type">windows::basic_handle::lowest_layer_type</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idp174722544"></a>
  31 A <a class="link" href="../windows__basic_handle.html" title="windows::basic_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_handle</span></code></a> is always the lowest
  32           layer.
  33         </p>
  34 <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">basic_handle</span><span class="special">&lt;</span> <span class="identifier">HandleService</span> <span class="special">&gt;</span> <span class="identifier">lowest_layer_type</span><span class="special">;</span>
  35 </pre>
  36 <h6>
  37 <a name="boost_asio.reference.windows__basic_handle.lowest_layer_type.h0"></a>
  38           <span class="phrase"><a name="boost_asio.reference.windows__basic_handle.lowest_layer_type.types"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_handle.lowest_layer_type.types">Types</a>
  39         </h6>
  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="implementation_type.html" title="windows::basic_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="lowest_layer_type.html" title="windows::basic_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="native_handle_type.html" title="windows::basic_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="native_type.html" title="windows::basic_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="service_type.html" title="windows::basic_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 <h6>
 122 <a name="boost_asio.reference.windows__basic_handle.lowest_layer_type.h1"></a>
 123           <span class="phrase"><a name="boost_asio.reference.windows__basic_handle.lowest_layer_type.member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_handle.lowest_layer_type.member_functions">Member
 124           Functions</a>
 125         </h6>
 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="assign.html" title="windows::basic_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="basic_handle.html" title="windows::basic_handle::basic_handle"><span class="bold"><strong>basic_handle</strong></span></a>
 160                   </p>
 161                 </td>
 162 <td>
 163                   <p>
 164                     Construct a basic_handle without opening it.
 165                   </p>
 166                   <p>
 167                     Construct a basic_handle on an existing native handle.
 168                   </p>
 169                   <p>
 170                     Move-construct a basic_handle from another.
 171                   </p>
 172                 </td>
 173 </tr>
 174 <tr>
 175 <td>
 176                   <p>
 177                     <a class="link" href="cancel.html" title="windows::basic_handle::cancel"><span class="bold"><strong>cancel</strong></span></a>
 178                   </p>
 179                 </td>
 180 <td>
 181                   <p>
 182                     Cancel all asynchronous operations associated with the handle.
 183                   </p>
 184                 </td>
 185 </tr>
 186 <tr>
 187 <td>
 188                   <p>
 189                     <a class="link" href="close.html" title="windows::basic_handle::close"><span class="bold"><strong>close</strong></span></a>
 190                   </p>
 191                 </td>
 192 <td>
 193                   <p>
 194                     Close the handle.
 195                   </p>
 196                 </td>
 197 </tr>
 198 <tr>
 199 <td>
 200                   <p>
 201                     <a class="link" href="get_io_service.html" title="windows::basic_handle::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
 202                   </p>
 203                 </td>
 204 <td>
 205                   <p>
 206                     Get the io_service associated with the object.
 207                   </p>
 208                 </td>
 209 </tr>
 210 <tr>
 211 <td>
 212                   <p>
 213                     <a class="link" href="is_open.html" title="windows::basic_handle::is_open"><span class="bold"><strong>is_open</strong></span></a>
 214                   </p>
 215                 </td>
 216 <td>
 217                   <p>
 218                     Determine whether the handle is open.
 219                   </p>
 220                 </td>
 221 </tr>
 222 <tr>
 223 <td>
 224                   <p>
 225                     <a class="link" href="lowest_layer.html" title="windows::basic_handle::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a>
 226                   </p>
 227                 </td>
 228 <td>
 229                   <p>
 230                     Get a reference to the lowest layer.
 231                   </p>
 232                   <p>
 233                     Get a const reference to the lowest layer.
 234                   </p>
 235                 </td>
 236 </tr>
 237 <tr>
 238 <td>
 239                   <p>
 240                     <a class="link" href="native.html" title="windows::basic_handle::native"><span class="bold"><strong>native</strong></span></a>
 241                   </p>
 242                 </td>
 243 <td>
 244                   <p>
 245                     (Deprecated: Use native_handle().) Get the native handle representation.
 246                   </p>
 247                 </td>
 248 </tr>
 249 <tr>
 250 <td>
 251                   <p>
 252                     <a class="link" href="native_handle.html" title="windows::basic_handle::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
 253                   </p>
 254                 </td>
 255 <td>
 256                   <p>
 257                     Get the native handle representation.
 258                   </p>
 259                 </td>
 260 </tr>
 261 <tr>
 262 <td>
 263                   <p>
 264                     <a class="link" href="operator_eq_.html" title="windows::basic_handle::operator="><span class="bold"><strong>operator=</strong></span></a>
 265                   </p>
 266                 </td>
 267 <td>
 268                   <p>
 269                     Move-assign a basic_handle from another.
 270                   </p>
 271                 </td>
 272 </tr>
 273 </tbody>
 274 </table></div>
 275 <h6>
 276 <a name="boost_asio.reference.windows__basic_handle.lowest_layer_type.h2"></a>
 277           <span class="phrase"><a name="boost_asio.reference.windows__basic_handle.lowest_layer_type.protected_member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_handle.lowest_layer_type.protected_member_functions">Protected
 278           Member Functions</a>
 279         </h6>
 280 <div class="informaltable"><table class="table">
 281 <colgroup>
 282 <col>
 283 <col>
 284 </colgroup>
 285 <thead><tr>
 286 <th>
 287                   <p>
 288                     Name
 289                   </p>
 290                 </th>
 291 <th>
 292                   <p>
 293                     Description
 294                   </p>
 295                 </th>
 296 </tr></thead>
 297 <tbody>
 298 <tr>
 299 <td>
 300                   <p>
 301                     <a class="link" href="get_implementation.html" title="windows::basic_handle::get_implementation"><span class="bold"><strong>get_implementation</strong></span></a>
 302                   </p>
 303                 </td>
 304 <td>
 305                   <p>
 306                     Get the underlying implementation of the I/O object.
 307                   </p>
 308                 </td>
 309 </tr>
 310 <tr>
 311 <td>
 312                   <p>
 313                     <a class="link" href="get_service.html" title="windows::basic_handle::get_service"><span class="bold"><strong>get_service</strong></span></a>
 314                   </p>
 315                 </td>
 316 <td>
 317                   <p>
 318                     Get the service associated with the I/O object.
 319                   </p>
 320                 </td>
 321 </tr>
 322 <tr>
 323 <td>
 324                   <p>
 325                     <a class="link" href="_basic_handle.html" title="windows::basic_handle::~basic_handle"><span class="bold"><strong>~basic_handle</strong></span></a>
 326                   </p>
 327                 </td>
 328 <td>
 329                   <p>
 330                     Protected destructor to prevent deletion through this type.
 331                   </p>
 332                 </td>
 333 </tr>
 334 </tbody>
 335 </table></div>
 336 <h6>
 337 <a name="boost_asio.reference.windows__basic_handle.lowest_layer_type.h3"></a>
 338           <span class="phrase"><a name="boost_asio.reference.windows__basic_handle.lowest_layer_type.protected_data_members"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_handle.lowest_layer_type.protected_data_members">Protected
 339           Data Members</a>
 340         </h6>
 341 <div class="informaltable"><table class="table">
 342 <colgroup>
 343 <col>
 344 <col>
 345 </colgroup>
 346 <thead><tr>
 347 <th>
 348                   <p>
 349                     Name
 350                   </p>
 351                 </th>
 352 <th>
 353                   <p>
 354                     Description
 355                   </p>
 356                 </th>
 357 </tr></thead>
 358 <tbody>
 359 <tr>
 360 <td>
 361                   <p>
 362                     <a class="link" href="implementation.html" title="windows::basic_handle::implementation"><span class="bold"><strong>implementation</strong></span></a>
 363                   </p>
 364                 </td>
 365 <td>
 366                   <p>
 367                     (Deprecated: Use get_implementation().) The underlying implementation
 368                     of the I/O object.
 369                   </p>
 370                 </td>
 371 </tr>
 372 <tr>
 373 <td>
 374                   <p>
 375                     <a class="link" href="service.html" title="windows::basic_handle::service"><span class="bold"><strong>service</strong></span></a>
 376                   </p>
 377                 </td>
 378 <td>
 379                   <p>
 380                     (Deprecated: Use get_service().) The service associated with
 381                     the I/O object.
 382                   </p>
 383                 </td>
 384 </tr>
 385 </tbody>
 386 </table></div>
 387 <p>
 388           The <a class="link" href="../windows__basic_handle.html" title="windows::basic_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_handle</span></code></a> class template provides
 389           the ability to wrap a Windows handle.
 390         </p>
 391 <h6>
 392 <a name="boost_asio.reference.windows__basic_handle.lowest_layer_type.h4"></a>
 393           <span class="phrase"><a name="boost_asio.reference.windows__basic_handle.lowest_layer_type.thread_safety"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_handle.lowest_layer_type.thread_safety">Thread
 394           Safety</a>
 395         </h6>
 396 <p>
 397           <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
 398         </p>
 399 <p>
 400           <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
 401         </p>
 402 <h6>
 403 <a name="boost_asio.reference.windows__basic_handle.lowest_layer_type.h5"></a>
 404           <span class="phrase"><a name="boost_asio.reference.windows__basic_handle.lowest_layer_type.requirements"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_handle.lowest_layer_type.requirements">Requirements</a>
 405         </h6>
 406 <p>
 407           <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/basic_handle.hpp</code>
 408         </p>
 409 <p>
 410           <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 411         </p>
 412 </div>
 413 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 414 <td align="left"></td>
 415 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
 416         Distributed under the Boost Software License, Version 1.0. (See accompanying
 417         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>)
 418       </p>
 419 </div></td>
 420 </tr></table>
 421 <hr>
 422 <div class="spirit-nav">
 423 <a accesskey="p" href="lowest_layer/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_handle.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="native.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 424 </div>
 425 </body>
 426 </html>