doc/html/boost_asio/reference/windows__basic_random_access_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_random_access_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_random_access_handle.html" title="windows::basic_random_access_handle">
   9 <link rel="prev" href="lowest_layer/overload2.html" title="windows::basic_random_access_handle::lowest_layer (2 of 2 overloads)">
  10 <link rel="next" href="native_handle.html" title="windows::basic_random_access_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_random_access_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_random_access_handle.lowest_layer_type"></a><a class="link" href="lowest_layer_type.html" title="windows::basic_random_access_handle::lowest_layer_type">windows::basic_random_access_handle::lowest_layer_type</a>
  28 </h4></div></div></div>
  29 <p>
  30           <span class="emphasis"><em>Inherited from windows::basic_overlapped_handle.</em></span>
  31         </p>
  32 <p>
  33           <a class="indexterm" name="boost_asio.indexterm.windows__basic_random_access_handle.lowest_layer_type"></a>
  34 An
  35           overlapped_handle is always the lowest layer.
  36         </p>
  37 <pre class="programlisting">typedef basic_overlapped_handle lowest_layer_type;
  38 </pre>
  39 <h6>
  40 <a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.h0"></a>
  41           <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.types"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.types">Types</a>
  42         </h6>
  43 <div class="informaltable"><table class="table">
  44 <colgroup>
  45 <col>
  46 <col>
  47 </colgroup>
  48 <thead><tr>
  49 <th>
  50                   <p>
  51                     Name
  52                   </p>
  53                 </th>
  54 <th>
  55                   <p>
  56                     Description
  57                   </p>
  58                 </th>
  59 </tr></thead>
  60 <tbody>
  61 <tr>
  62 <td>
  63                   <p>
  64                     <a class="link" href="../windows__basic_overlapped_handle__rebind_executor.html" title="windows::basic_overlapped_handle::rebind_executor"><span class="bold"><strong>rebind_executor</strong></span></a>
  65                   </p>
  66                 </td>
  67 <td>
  68                   <p>
  69                     Rebinds the handle type to another executor.
  70                   </p>
  71                 </td>
  72 </tr>
  73 <tr>
  74 <td>
  75                   <p>
  76                     <a class="link" href="../windows__basic_overlapped_handle/executor_type.html" title="windows::basic_overlapped_handle::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
  77                   </p>
  78                 </td>
  79 <td>
  80                   <p>
  81                     The type of the executor associated with the object.
  82                   </p>
  83                 </td>
  84 </tr>
  85 <tr>
  86 <td>
  87                   <p>
  88                     <a class="link" href="../windows__basic_overlapped_handle/lowest_layer_type.html" title="windows::basic_overlapped_handle::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a>
  89                   </p>
  90                 </td>
  91 <td>
  92                   <p>
  93                     An overlapped_handle is always the lowest layer.
  94                   </p>
  95                 </td>
  96 </tr>
  97 <tr>
  98 <td>
  99                   <p>
 100                     <a class="link" href="../windows__basic_overlapped_handle/native_handle_type.html" title="windows::basic_overlapped_handle::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a>
 101                   </p>
 102                 </td>
 103 <td>
 104                   <p>
 105                     The native representation of a handle.
 106                   </p>
 107                 </td>
 108 </tr>
 109 </tbody>
 110 </table></div>
 111 <h6>
 112 <a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.h1"></a>
 113           <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.member_functions">Member
 114           Functions</a>
 115         </h6>
 116 <div class="informaltable"><table class="table">
 117 <colgroup>
 118 <col>
 119 <col>
 120 </colgroup>
 121 <thead><tr>
 122 <th>
 123                   <p>
 124                     Name
 125                   </p>
 126                 </th>
 127 <th>
 128                   <p>
 129                     Description
 130                   </p>
 131                 </th>
 132 </tr></thead>
 133 <tbody>
 134 <tr>
 135 <td>
 136                   <p>
 137                     <a class="link" href="../windows__basic_overlapped_handle/assign.html" title="windows::basic_overlapped_handle::assign"><span class="bold"><strong>assign</strong></span></a>
 138                   </p>
 139                 </td>
 140 <td>
 141                   <p>
 142                     Assign an existing native handle to the handle.
 143                   </p>
 144                 </td>
 145 </tr>
 146 <tr>
 147 <td>
 148                   <p>
 149                     <a class="link" href="../windows__basic_overlapped_handle/basic_overlapped_handle.html" title="windows::basic_overlapped_handle::basic_overlapped_handle"><span class="bold"><strong>basic_overlapped_handle</strong></span></a>
 150                   </p>
 151                 </td>
 152 <td>
 153                   <p>
 154                     Construct an overlapped handle without opening it. <br> <span class="silver"> &#8212;</span><br>
 155                     Construct an overlapped handle on an existing native handle.
 156                     <br> <span class="silver"> &#8212;</span><br> Move-construct an overlapped handle from another.
 157                   </p>
 158                 </td>
 159 </tr>
 160 <tr>
 161 <td>
 162                   <p>
 163                     <a class="link" href="../windows__basic_overlapped_handle/cancel.html" title="windows::basic_overlapped_handle::cancel"><span class="bold"><strong>cancel</strong></span></a>
 164                   </p>
 165                 </td>
 166 <td>
 167                   <p>
 168                     Cancel all asynchronous operations associated with the handle.
 169                   </p>
 170                 </td>
 171 </tr>
 172 <tr>
 173 <td>
 174                   <p>
 175                     <a class="link" href="../windows__basic_overlapped_handle/close.html" title="windows::basic_overlapped_handle::close"><span class="bold"><strong>close</strong></span></a>
 176                   </p>
 177                 </td>
 178 <td>
 179                   <p>
 180                     Close the handle.
 181                   </p>
 182                 </td>
 183 </tr>
 184 <tr>
 185 <td>
 186                   <p>
 187                     <a class="link" href="../windows__basic_overlapped_handle/get_executor.html" title="windows::basic_overlapped_handle::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
 188                   </p>
 189                 </td>
 190 <td>
 191                   <p>
 192                     Get the executor associated with the object.
 193                   </p>
 194                 </td>
 195 </tr>
 196 <tr>
 197 <td>
 198                   <p>
 199                     <a class="link" href="../windows__basic_overlapped_handle/is_open.html" title="windows::basic_overlapped_handle::is_open"><span class="bold"><strong>is_open</strong></span></a>
 200                   </p>
 201                 </td>
 202 <td>
 203                   <p>
 204                     Determine whether the handle is open.
 205                   </p>
 206                 </td>
 207 </tr>
 208 <tr>
 209 <td>
 210                   <p>
 211                     <a class="link" href="../windows__basic_overlapped_handle/lowest_layer.html" title="windows::basic_overlapped_handle::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a>
 212                   </p>
 213                 </td>
 214 <td>
 215                   <p>
 216                     Get a reference to the lowest layer. <br> <span class="silver"> &#8212;</span><br> Get a const
 217                     reference to the lowest layer.
 218                   </p>
 219                 </td>
 220 </tr>
 221 <tr>
 222 <td>
 223                   <p>
 224                     <a class="link" href="../windows__basic_overlapped_handle/native_handle.html" title="windows::basic_overlapped_handle::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
 225                   </p>
 226                 </td>
 227 <td>
 228                   <p>
 229                     Get the native handle representation.
 230                   </p>
 231                 </td>
 232 </tr>
 233 <tr>
 234 <td>
 235                   <p>
 236                     <a class="link" href="../windows__basic_overlapped_handle/operator_eq_.html" title="windows::basic_overlapped_handle::operator="><span class="bold"><strong>operator=</strong></span></a>
 237                   </p>
 238                 </td>
 239 <td>
 240                   <p>
 241                     Move-assign an overlapped handle from another.
 242                   </p>
 243                 </td>
 244 </tr>
 245 </tbody>
 246 </table></div>
 247 <h6>
 248 <a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.h2"></a>
 249           <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.protected_member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.protected_member_functions">Protected
 250           Member Functions</a>
 251         </h6>
 252 <div class="informaltable"><table class="table">
 253 <colgroup>
 254 <col>
 255 <col>
 256 </colgroup>
 257 <thead><tr>
 258 <th>
 259                   <p>
 260                     Name
 261                   </p>
 262                 </th>
 263 <th>
 264                   <p>
 265                     Description
 266                   </p>
 267                 </th>
 268 </tr></thead>
 269 <tbody><tr>
 270 <td>
 271                   <p>
 272                     <a class="link" href="../windows__basic_overlapped_handle/_basic_overlapped_handle.html" title="windows::basic_overlapped_handle::~basic_overlapped_handle"><span class="bold"><strong>~basic_overlapped_handle</strong></span></a>
 273                   </p>
 274                 </td>
 275 <td>
 276                   <p>
 277                     Protected destructor to prevent deletion through this type.
 278                   </p>
 279                 </td>
 280 </tr></tbody>
 281 </table></div>
 282 <h6>
 283 <a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.h3"></a>
 284           <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.protected_data_members"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.protected_data_members">Protected
 285           Data Members</a>
 286         </h6>
 287 <div class="informaltable"><table class="table">
 288 <colgroup>
 289 <col>
 290 <col>
 291 </colgroup>
 292 <thead><tr>
 293 <th>
 294                   <p>
 295                     Name
 296                   </p>
 297                 </th>
 298 <th>
 299                   <p>
 300                     Description
 301                   </p>
 302                 </th>
 303 </tr></thead>
 304 <tbody><tr>
 305 <td>
 306                   <p>
 307                     <a class="link" href="../windows__basic_overlapped_handle/impl_.html" title="windows::basic_overlapped_handle::impl_"><span class="bold"><strong>impl_</strong></span></a>
 308                   </p>
 309                 </td>
 310 <td>
 311                 </td>
 312 </tr></tbody>
 313 </table></div>
 314 <p>
 315           The <a class="link" href="../windows__overlapped_handle.html" title="windows::overlapped_handle"><code class="computeroutput">windows::overlapped_handle</code></a>
 316           class provides the ability to wrap a Windows handle. The underlying object
 317           referred to by the handle must support overlapped I/O.
 318         </p>
 319 <h6>
 320 <a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.h4"></a>
 321           <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.thread_safety"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.thread_safety">Thread
 322           Safety</a>
 323         </h6>
 324 <p>
 325           <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
 326         </p>
 327 <p>
 328           <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
 329         </p>
 330 <h6>
 331 <a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.h5"></a>
 332           <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.requirements"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.windows__basic_random_access_handle.lowest_layer_type.requirements">Requirements</a>
 333         </h6>
 334 <p>
 335           <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/basic_random_access_handle.hpp</code>
 336         </p>
 337 <p>
 338           <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 339         </p>
 340 </div>
 341 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 342 <td align="left"></td>
 343 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
 344         Distributed under the Boost Software License, Version 1.0. (See accompanying
 345         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>)
 346       </p>
 347 </div></td>
 348 </tr></table>
 349 <hr>
 350 <div class="spirit-nav">
 351 <a accesskey="p" href="lowest_layer/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_random_access_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>
 352 </div>
 353 </body>
 354 </html>