doc/html/boost_asio/reference/windows__basic_object_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_object_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_object_handle.html" title="windows::basic_object_handle">
   9 <link rel="prev" href="lowest_layer/overload2.html" title="windows::basic_object_handle::lowest_layer (2 of 2 overloads)">
  10 <link rel="next" href="native_handle.html" title="windows::basic_object_handle::native_handle">
  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_object_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_handle.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_object_handle.lowest_layer_type"></a><a class="link" href="lowest_layer_type.html" title="windows::basic_object_handle::lowest_layer_type">windows::basic_object_handle::lowest_layer_type</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="boost_asio.indexterm.windows__basic_object_handle.lowest_layer_type"></a>
  31 An
  32           object handle is always the lowest layer.
  33         </p>
  34 <pre class="programlisting">typedef basic_object_handle lowest_layer_type;
  35 </pre>
  36 <h6>
  37 <a name="boost_asio.reference.windows__basic_object_handle.lowest_layer_type.h0"></a>
  38           <span class="phrase"><a name="boost_asio.reference.windows__basic_object_handle.lowest_layer_type.types"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_object_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="../windows__basic_object_handle__rebind_executor.html" title="windows::basic_object_handle::rebind_executor"><span class="bold"><strong>rebind_executor</strong></span></a>
  62                   </p>
  63                 </td>
  64 <td>
  65                   <p>
  66                     Rebinds the handle type to another executor.
  67                   </p>
  68                 </td>
  69 </tr>
  70 <tr>
  71 <td>
  72                   <p>
  73                     <a class="link" href="executor_type.html" title="windows::basic_object_handle::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
  74                   </p>
  75                 </td>
  76 <td>
  77                   <p>
  78                     The type of the executor associated with the object.
  79                   </p>
  80                 </td>
  81 </tr>
  82 <tr>
  83 <td>
  84                   <p>
  85                     <a class="link" href="lowest_layer_type.html" title="windows::basic_object_handle::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a>
  86                   </p>
  87                 </td>
  88 <td>
  89                   <p>
  90                     An object handle is always the lowest layer.
  91                   </p>
  92                 </td>
  93 </tr>
  94 <tr>
  95 <td>
  96                   <p>
  97                     <a class="link" href="native_handle_type.html" title="windows::basic_object_handle::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a>
  98                   </p>
  99                 </td>
 100 <td>
 101                   <p>
 102                     The native representation of a handle.
 103                   </p>
 104                 </td>
 105 </tr>
 106 </tbody>
 107 </table></div>
 108 <h6>
 109 <a name="boost_asio.reference.windows__basic_object_handle.lowest_layer_type.h1"></a>
 110           <span class="phrase"><a name="boost_asio.reference.windows__basic_object_handle.lowest_layer_type.member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_object_handle.lowest_layer_type.member_functions">Member
 111           Functions</a>
 112         </h6>
 113 <div class="informaltable"><table class="table">
 114 <colgroup>
 115 <col>
 116 <col>
 117 </colgroup>
 118 <thead><tr>
 119 <th>
 120                   <p>
 121                     Name
 122                   </p>
 123                 </th>
 124 <th>
 125                   <p>
 126                     Description
 127                   </p>
 128                 </th>
 129 </tr></thead>
 130 <tbody>
 131 <tr>
 132 <td>
 133                   <p>
 134                     <a class="link" href="assign.html" title="windows::basic_object_handle::assign"><span class="bold"><strong>assign</strong></span></a>
 135                   </p>
 136                 </td>
 137 <td>
 138                   <p>
 139                     Assign an existing native handle to the handle.
 140                   </p>
 141                 </td>
 142 </tr>
 143 <tr>
 144 <td>
 145                   <p>
 146                     <a class="link" href="async_wait.html" title="windows::basic_object_handle::async_wait"><span class="bold"><strong>async_wait</strong></span></a>
 147                   </p>
 148                 </td>
 149 <td>
 150                   <p>
 151                     Start an asynchronous wait on the object handle.
 152                   </p>
 153                 </td>
 154 </tr>
 155 <tr>
 156 <td>
 157                   <p>
 158                     <a class="link" href="basic_object_handle.html" title="windows::basic_object_handle::basic_object_handle"><span class="bold"><strong>basic_object_handle</strong></span></a>
 159                   </p>
 160                 </td>
 161 <td>
 162                   <p>
 163                     Construct an object handle without opening it. <br> <span class="silver"> &#8212;</span><br>
 164                     Construct an object handle on an existing native handle. <br>
 165                     <span class="silver"> &#8212;</span><br> Move-construct an object handle from another.
 166                   </p>
 167                 </td>
 168 </tr>
 169 <tr>
 170 <td>
 171                   <p>
 172                     <a class="link" href="cancel.html" title="windows::basic_object_handle::cancel"><span class="bold"><strong>cancel</strong></span></a>
 173                   </p>
 174                 </td>
 175 <td>
 176                   <p>
 177                     Cancel all asynchronous operations associated with the handle.
 178                   </p>
 179                 </td>
 180 </tr>
 181 <tr>
 182 <td>
 183                   <p>
 184                     <a class="link" href="close.html" title="windows::basic_object_handle::close"><span class="bold"><strong>close</strong></span></a>
 185                   </p>
 186                 </td>
 187 <td>
 188                   <p>
 189                     Close the handle.
 190                   </p>
 191                 </td>
 192 </tr>
 193 <tr>
 194 <td>
 195                   <p>
 196                     <a class="link" href="get_executor.html" title="windows::basic_object_handle::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
 197                   </p>
 198                 </td>
 199 <td>
 200                   <p>
 201                     Get the executor associated with the object.
 202                   </p>
 203                 </td>
 204 </tr>
 205 <tr>
 206 <td>
 207                   <p>
 208                     <a class="link" href="is_open.html" title="windows::basic_object_handle::is_open"><span class="bold"><strong>is_open</strong></span></a>
 209                   </p>
 210                 </td>
 211 <td>
 212                   <p>
 213                     Determine whether the handle is open.
 214                   </p>
 215                 </td>
 216 </tr>
 217 <tr>
 218 <td>
 219                   <p>
 220                     <a class="link" href="lowest_layer.html" title="windows::basic_object_handle::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a>
 221                   </p>
 222                 </td>
 223 <td>
 224                   <p>
 225                     Get a reference to the lowest layer. <br> <span class="silver"> &#8212;</span><br> Get a const
 226                     reference to the lowest layer.
 227                   </p>
 228                 </td>
 229 </tr>
 230 <tr>
 231 <td>
 232                   <p>
 233                     <a class="link" href="native_handle.html" title="windows::basic_object_handle::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
 234                   </p>
 235                 </td>
 236 <td>
 237                   <p>
 238                     Get the native handle representation.
 239                   </p>
 240                 </td>
 241 </tr>
 242 <tr>
 243 <td>
 244                   <p>
 245                     <a class="link" href="operator_eq_.html" title="windows::basic_object_handle::operator="><span class="bold"><strong>operator=</strong></span></a>
 246                   </p>
 247                 </td>
 248 <td>
 249                   <p>
 250                     Move-assign an object handle from another.
 251                   </p>
 252                 </td>
 253 </tr>
 254 <tr>
 255 <td>
 256                   <p>
 257                     <a class="link" href="wait.html" title="windows::basic_object_handle::wait"><span class="bold"><strong>wait</strong></span></a>
 258                   </p>
 259                 </td>
 260 <td>
 261                   <p>
 262                     Perform a blocking wait on the object handle.
 263                   </p>
 264                 </td>
 265 </tr>
 266 </tbody>
 267 </table></div>
 268 <p>
 269           The <a class="link" href="../windows__basic_object_handle.html" title="windows::basic_object_handle"><code class="computeroutput">windows::basic_object_handle</code></a>
 270           class provides asynchronous and blocking object-oriented handle functionality.
 271         </p>
 272 <h6>
 273 <a name="boost_asio.reference.windows__basic_object_handle.lowest_layer_type.h2"></a>
 274           <span class="phrase"><a name="boost_asio.reference.windows__basic_object_handle.lowest_layer_type.thread_safety"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_object_handle.lowest_layer_type.thread_safety">Thread
 275           Safety</a>
 276         </h6>
 277 <p>
 278           <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
 279         </p>
 280 <p>
 281           <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
 282         </p>
 283 <h6>
 284 <a name="boost_asio.reference.windows__basic_object_handle.lowest_layer_type.h3"></a>
 285           <span class="phrase"><a name="boost_asio.reference.windows__basic_object_handle.lowest_layer_type.requirements"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_object_handle.lowest_layer_type.requirements">Requirements</a>
 286         </h6>
 287 <p>
 288           <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/basic_object_handle.hpp</code>
 289         </p>
 290 <p>
 291           <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 292         </p>
 293 </div>
 294 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 295 <td align="left"></td>
 296 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
 297         Distributed under the Boost Software License, Version 1.0. (See accompanying
 298         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>)
 299       </p>
 300 </div></td>
 301 </tr></table>
 302 <hr>
 303 <div class="spirit-nav">
 304 <a accesskey="p" href="lowest_layer/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_object_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_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 305 </div>
 306 </body>
 307 </html>