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