doc/html/boost_asio/reference/posix__basic_stream_descriptor/lowest_layer_type.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>posix::basic_stream_descriptor::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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor">
   9 <link rel="prev" href="lowest_layer/overload2.html" title="posix::basic_stream_descriptor::lowest_layer (2 of 2 overloads)">
  10 <link rel="next" href="native_handle.html" title="posix::basic_stream_descriptor::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="../posix__basic_stream_descriptor.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.posix__basic_stream_descriptor.lowest_layer_type"></a><a class="link" href="lowest_layer_type.html" title="posix::basic_stream_descriptor::lowest_layer_type">posix::basic_stream_descriptor::lowest_layer_type</a>
  28 </h4></div></div></div>
  29 <p>
  30           <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span>
  31         </p>
  32 <p>
  33           <a class="indexterm" name="boost_asio.indexterm.posix__basic_stream_descriptor.lowest_layer_type"></a>
  34 A
  35           descriptor is always the lowest layer.
  36         </p>
  37 <pre class="programlisting">typedef basic_descriptor lowest_layer_type;
  38 </pre>
  39 <h6>
  40 <a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.h0"></a>
  41           <span class="phrase"><a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.types"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.posix__basic_stream_descriptor.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="../posix__basic_descriptor__rebind_executor.html" title="posix::basic_descriptor::rebind_executor"><span class="bold"><strong>rebind_executor</strong></span></a>
  65                   </p>
  66                 </td>
  67 <td>
  68                   <p>
  69                     Rebinds the descriptor type to another executor.
  70                   </p>
  71                 </td>
  72 </tr>
  73 <tr>
  74 <td>
  75                   <p>
  76                     <a class="link" href="../posix__basic_descriptor/bytes_readable.html" title="posix::basic_descriptor::bytes_readable"><span class="bold"><strong>bytes_readable</strong></span></a>
  77                   </p>
  78                 </td>
  79 <td>
  80                   <p>
  81                     IO control command to get the amount of data that can be read
  82                     without blocking.
  83                   </p>
  84                 </td>
  85 </tr>
  86 <tr>
  87 <td>
  88                   <p>
  89                     <a class="link" href="../posix__basic_descriptor/executor_type.html" title="posix::basic_descriptor::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
  90                   </p>
  91                 </td>
  92 <td>
  93                   <p>
  94                     The type of the executor associated with the object.
  95                   </p>
  96                 </td>
  97 </tr>
  98 <tr>
  99 <td>
 100                   <p>
 101                     <a class="link" href="../posix__basic_descriptor/lowest_layer_type.html" title="posix::basic_descriptor::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a>
 102                   </p>
 103                 </td>
 104 <td>
 105                   <p>
 106                     A descriptor is always the lowest layer.
 107                   </p>
 108                 </td>
 109 </tr>
 110 <tr>
 111 <td>
 112                   <p>
 113                     <a class="link" href="../posix__basic_descriptor/native_handle_type.html" title="posix::basic_descriptor::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a>
 114                   </p>
 115                 </td>
 116 <td>
 117                   <p>
 118                     The native representation of a descriptor.
 119                   </p>
 120                 </td>
 121 </tr>
 122 <tr>
 123 <td>
 124                   <p>
 125                     <a class="link" href="../posix__basic_descriptor/wait_type.html" title="posix::basic_descriptor::wait_type"><span class="bold"><strong>wait_type</strong></span></a>
 126                   </p>
 127                 </td>
 128 <td>
 129                   <p>
 130                     Wait types.
 131                   </p>
 132                 </td>
 133 </tr>
 134 </tbody>
 135 </table></div>
 136 <h6>
 137 <a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.h1"></a>
 138           <span class="phrase"><a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.member_functions">Member
 139           Functions</a>
 140         </h6>
 141 <div class="informaltable"><table class="table">
 142 <colgroup>
 143 <col>
 144 <col>
 145 </colgroup>
 146 <thead><tr>
 147 <th>
 148                   <p>
 149                     Name
 150                   </p>
 151                 </th>
 152 <th>
 153                   <p>
 154                     Description
 155                   </p>
 156                 </th>
 157 </tr></thead>
 158 <tbody>
 159 <tr>
 160 <td>
 161                   <p>
 162                     <a class="link" href="../posix__basic_descriptor/assign.html" title="posix::basic_descriptor::assign"><span class="bold"><strong>assign</strong></span></a>
 163                   </p>
 164                 </td>
 165 <td>
 166                   <p>
 167                     Assign an existing native descriptor to the descriptor.
 168                   </p>
 169                 </td>
 170 </tr>
 171 <tr>
 172 <td>
 173                   <p>
 174                     <a class="link" href="../posix__basic_descriptor/async_wait.html" title="posix::basic_descriptor::async_wait"><span class="bold"><strong>async_wait</strong></span></a>
 175                   </p>
 176                 </td>
 177 <td>
 178                   <p>
 179                     Asynchronously wait for the descriptor to become ready to read,
 180                     ready to write, or to have pending error conditions.
 181                   </p>
 182                 </td>
 183 </tr>
 184 <tr>
 185 <td>
 186                   <p>
 187                     <a class="link" href="../posix__basic_descriptor/basic_descriptor.html" title="posix::basic_descriptor::basic_descriptor"><span class="bold"><strong>basic_descriptor</strong></span></a>
 188                   </p>
 189                 </td>
 190 <td>
 191                   <p>
 192                     Construct a descriptor without opening it. <br> <span class="silver"> &#8212;</span><br> Construct
 193                     a descriptor on an existing native descriptor. <br> <span class="silver"> &#8212;</span><br>
 194                     Move-construct a descriptor from another.
 195                   </p>
 196                 </td>
 197 </tr>
 198 <tr>
 199 <td>
 200                   <p>
 201                     <a class="link" href="../posix__basic_descriptor/cancel.html" title="posix::basic_descriptor::cancel"><span class="bold"><strong>cancel</strong></span></a>
 202                   </p>
 203                 </td>
 204 <td>
 205                   <p>
 206                     Cancel all asynchronous operations associated with the descriptor.
 207                   </p>
 208                 </td>
 209 </tr>
 210 <tr>
 211 <td>
 212                   <p>
 213                     <a class="link" href="../posix__basic_descriptor/close.html" title="posix::basic_descriptor::close"><span class="bold"><strong>close</strong></span></a>
 214                   </p>
 215                 </td>
 216 <td>
 217                   <p>
 218                     Close the descriptor.
 219                   </p>
 220                 </td>
 221 </tr>
 222 <tr>
 223 <td>
 224                   <p>
 225                     <a class="link" href="../posix__basic_descriptor/get_executor.html" title="posix::basic_descriptor::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
 226                   </p>
 227                 </td>
 228 <td>
 229                   <p>
 230                     Get the executor associated with the object.
 231                   </p>
 232                 </td>
 233 </tr>
 234 <tr>
 235 <td>
 236                   <p>
 237                     <a class="link" href="../posix__basic_descriptor/io_control.html" title="posix::basic_descriptor::io_control"><span class="bold"><strong>io_control</strong></span></a>
 238                   </p>
 239                 </td>
 240 <td>
 241                   <p>
 242                     Perform an IO control command on the descriptor.
 243                   </p>
 244                 </td>
 245 </tr>
 246 <tr>
 247 <td>
 248                   <p>
 249                     <a class="link" href="../posix__basic_descriptor/is_open.html" title="posix::basic_descriptor::is_open"><span class="bold"><strong>is_open</strong></span></a>
 250                   </p>
 251                 </td>
 252 <td>
 253                   <p>
 254                     Determine whether the descriptor is open.
 255                   </p>
 256                 </td>
 257 </tr>
 258 <tr>
 259 <td>
 260                   <p>
 261                     <a class="link" href="../posix__basic_descriptor/lowest_layer.html" title="posix::basic_descriptor::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a>
 262                   </p>
 263                 </td>
 264 <td>
 265                   <p>
 266                     Get a reference to the lowest layer. <br> <span class="silver"> &#8212;</span><br> Get a const
 267                     reference to the lowest layer.
 268                   </p>
 269                 </td>
 270 </tr>
 271 <tr>
 272 <td>
 273                   <p>
 274                     <a class="link" href="../posix__basic_descriptor/native_handle.html" title="posix::basic_descriptor::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
 275                   </p>
 276                 </td>
 277 <td>
 278                   <p>
 279                     Get the native descriptor representation.
 280                   </p>
 281                 </td>
 282 </tr>
 283 <tr>
 284 <td>
 285                   <p>
 286                     <a class="link" href="../posix__basic_descriptor/native_non_blocking.html" title="posix::basic_descriptor::native_non_blocking"><span class="bold"><strong>native_non_blocking</strong></span></a>
 287                   </p>
 288                 </td>
 289 <td>
 290                   <p>
 291                     Gets the non-blocking mode of the native descriptor implementation.
 292                     <br> <span class="silver"> &#8212;</span><br> Sets the non-blocking mode of the native descriptor
 293                     implementation.
 294                   </p>
 295                 </td>
 296 </tr>
 297 <tr>
 298 <td>
 299                   <p>
 300                     <a class="link" href="../posix__basic_descriptor/non_blocking.html" title="posix::basic_descriptor::non_blocking"><span class="bold"><strong>non_blocking</strong></span></a>
 301                   </p>
 302                 </td>
 303 <td>
 304                   <p>
 305                     Gets the non-blocking mode of the descriptor. <br> <span class="silver"> &#8212;</span><br> Sets
 306                     the non-blocking mode of the descriptor.
 307                   </p>
 308                 </td>
 309 </tr>
 310 <tr>
 311 <td>
 312                   <p>
 313                     <a class="link" href="../posix__basic_descriptor/operator_eq_.html" title="posix::basic_descriptor::operator="><span class="bold"><strong>operator=</strong></span></a>
 314                   </p>
 315                 </td>
 316 <td>
 317                   <p>
 318                     Move-assign a descriptor from another.
 319                   </p>
 320                 </td>
 321 </tr>
 322 <tr>
 323 <td>
 324                   <p>
 325                     <a class="link" href="../posix__basic_descriptor/release.html" title="posix::basic_descriptor::release"><span class="bold"><strong>release</strong></span></a>
 326                   </p>
 327                 </td>
 328 <td>
 329                   <p>
 330                     Release ownership of the native descriptor implementation.
 331                   </p>
 332                 </td>
 333 </tr>
 334 <tr>
 335 <td>
 336                   <p>
 337                     <a class="link" href="../posix__basic_descriptor/wait.html" title="posix::basic_descriptor::wait"><span class="bold"><strong>wait</strong></span></a>
 338                   </p>
 339                 </td>
 340 <td>
 341                   <p>
 342                     Wait for the descriptor to become ready to read, ready to write,
 343                     or to have pending error conditions.
 344                   </p>
 345                 </td>
 346 </tr>
 347 </tbody>
 348 </table></div>
 349 <h6>
 350 <a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.h2"></a>
 351           <span class="phrase"><a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.protected_member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.protected_member_functions">Protected
 352           Member Functions</a>
 353         </h6>
 354 <div class="informaltable"><table class="table">
 355 <colgroup>
 356 <col>
 357 <col>
 358 </colgroup>
 359 <thead><tr>
 360 <th>
 361                   <p>
 362                     Name
 363                   </p>
 364                 </th>
 365 <th>
 366                   <p>
 367                     Description
 368                   </p>
 369                 </th>
 370 </tr></thead>
 371 <tbody><tr>
 372 <td>
 373                   <p>
 374                     <a class="link" href="../posix__basic_descriptor/_basic_descriptor.html" title="posix::basic_descriptor::~basic_descriptor"><span class="bold"><strong>~basic_descriptor</strong></span></a>
 375                   </p>
 376                 </td>
 377 <td>
 378                   <p>
 379                     Protected destructor to prevent deletion through this type.
 380                   </p>
 381                 </td>
 382 </tr></tbody>
 383 </table></div>
 384 <h6>
 385 <a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.h3"></a>
 386           <span class="phrase"><a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.protected_data_members"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.protected_data_members">Protected
 387           Data Members</a>
 388         </h6>
 389 <div class="informaltable"><table class="table">
 390 <colgroup>
 391 <col>
 392 <col>
 393 </colgroup>
 394 <thead><tr>
 395 <th>
 396                   <p>
 397                     Name
 398                   </p>
 399                 </th>
 400 <th>
 401                   <p>
 402                     Description
 403                   </p>
 404                 </th>
 405 </tr></thead>
 406 <tbody><tr>
 407 <td>
 408                   <p>
 409                     <a class="link" href="../posix__basic_descriptor/impl_.html" title="posix::basic_descriptor::impl_"><span class="bold"><strong>impl_</strong></span></a>
 410                   </p>
 411                 </td>
 412 <td>
 413                 </td>
 414 </tr></tbody>
 415 </table></div>
 416 <p>
 417           The <a class="link" href="../posix__basic_descriptor.html" title="posix::basic_descriptor"><code class="computeroutput">posix::basic_descriptor</code></a>
 418           class template provides the ability to wrap a POSIX descriptor.
 419         </p>
 420 <h6>
 421 <a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.h4"></a>
 422           <span class="phrase"><a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.thread_safety"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.thread_safety">Thread
 423           Safety</a>
 424         </h6>
 425 <p>
 426           <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
 427         </p>
 428 <p>
 429           <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
 430         </p>
 431 <h6>
 432 <a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.h5"></a>
 433           <span class="phrase"><a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.requirements"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.requirements">Requirements</a>
 434         </h6>
 435 <p>
 436           <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/posix/basic_stream_descriptor.hpp</code>
 437         </p>
 438 <p>
 439           <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 440         </p>
 441 </div>
 442 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 443 <td align="left"></td>
 444 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
 445         Distributed under the Boost Software License, Version 1.0. (See accompanying
 446         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>)
 447       </p>
 448 </div></td>
 449 </tr></table>
 450 <hr>
 451 <div class="spirit-nav">
 452 <a accesskey="p" href="lowest_layer/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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>
 453 </div>
 454 </body>
 455 </html>