doc/html/boost_asio/reference/posix__stream_descriptor.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>posix::stream_descriptor</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../boost_asio.html" title="Boost.Asio">
   8 <link rel="up" href="../reference.html" title="Reference">
   9 <link rel="prev" href="posix__descriptor_base/_descriptor_base.html" title="posix::descriptor_base::~descriptor_base">
  10 <link rel="next" href="posix__stream_descriptor_service.html" title="posix::stream_descriptor_service">
  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="posix__descriptor_base/_descriptor_base.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="posix__stream_descriptor_service.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_asio.reference.posix__stream_descriptor"></a><a class="link" href="posix__stream_descriptor.html" title="posix::stream_descriptor">posix::stream_descriptor</a>
  28 </h3></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idp185607296"></a>
  31 Typedef for the typical usage of a stream-oriented
  32         descriptor.
  33       </p>
  34 <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">basic_stream_descriptor</span> <span class="identifier">stream_descriptor</span><span class="special">;</span>
  35 </pre>
  36 <h5>
  37 <a name="boost_asio.reference.posix__stream_descriptor.h0"></a>
  38         <span class="phrase"><a name="boost_asio.reference.posix__stream_descriptor.types"></a></span><a class="link" href="posix__stream_descriptor.html#boost_asio.reference.posix__stream_descriptor.types">Types</a>
  39       </h5>
  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="posix__basic_stream_descriptor/bytes_readable.html" title="posix::basic_stream_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 without
  67                   blocking.
  68                 </p>
  69               </td>
  70 </tr>
  71 <tr>
  72 <td>
  73                 <p>
  74                   <a class="link" href="posix__basic_stream_descriptor/implementation_type.html" title="posix::basic_stream_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="posix__basic_stream_descriptor/lowest_layer_type.html" title="posix::basic_stream_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="posix__basic_stream_descriptor/native_handle_type.html" title="posix::basic_stream_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="posix__basic_stream_descriptor/native_type.html" title="posix::basic_stream_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="posix__basic_stream_descriptor/non_blocking_io.html" title="posix::basic_stream_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="posix__basic_stream_descriptor/service_type.html" title="posix::basic_stream_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 <h5>
 148 <a name="boost_asio.reference.posix__stream_descriptor.h1"></a>
 149         <span class="phrase"><a name="boost_asio.reference.posix__stream_descriptor.member_functions"></a></span><a class="link" href="posix__stream_descriptor.html#boost_asio.reference.posix__stream_descriptor.member_functions">Member
 150         Functions</a>
 151       </h5>
 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="posix__basic_stream_descriptor/assign.html" title="posix::basic_stream_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="posix__basic_stream_descriptor/async_read_some.html" title="posix::basic_stream_descriptor::async_read_some"><span class="bold"><strong>async_read_some</strong></span></a>
 186                 </p>
 187               </td>
 188 <td>
 189                 <p>
 190                   Start an asynchronous read.
 191                 </p>
 192               </td>
 193 </tr>
 194 <tr>
 195 <td>
 196                 <p>
 197                   <a class="link" href="posix__basic_stream_descriptor/async_write_some.html" title="posix::basic_stream_descriptor::async_write_some"><span class="bold"><strong>async_write_some</strong></span></a>
 198                 </p>
 199               </td>
 200 <td>
 201                 <p>
 202                   Start an asynchronous write.
 203                 </p>
 204               </td>
 205 </tr>
 206 <tr>
 207 <td>
 208                 <p>
 209                   <a class="link" href="posix__basic_stream_descriptor/basic_stream_descriptor.html" title="posix::basic_stream_descriptor::basic_stream_descriptor"><span class="bold"><strong>basic_stream_descriptor</strong></span></a>
 210                 </p>
 211               </td>
 212 <td>
 213                 <p>
 214                   Construct a basic_stream_descriptor without opening it.
 215                 </p>
 216                 <p>
 217                   Construct a basic_stream_descriptor on an existing native descriptor.
 218                 </p>
 219                 <p>
 220                   Move-construct a basic_stream_descriptor from another.
 221                 </p>
 222               </td>
 223 </tr>
 224 <tr>
 225 <td>
 226                 <p>
 227                   <a class="link" href="posix__basic_stream_descriptor/cancel.html" title="posix::basic_stream_descriptor::cancel"><span class="bold"><strong>cancel</strong></span></a>
 228                 </p>
 229               </td>
 230 <td>
 231                 <p>
 232                   Cancel all asynchronous operations associated with the descriptor.
 233                 </p>
 234               </td>
 235 </tr>
 236 <tr>
 237 <td>
 238                 <p>
 239                   <a class="link" href="posix__basic_stream_descriptor/close.html" title="posix::basic_stream_descriptor::close"><span class="bold"><strong>close</strong></span></a>
 240                 </p>
 241               </td>
 242 <td>
 243                 <p>
 244                   Close the descriptor.
 245                 </p>
 246               </td>
 247 </tr>
 248 <tr>
 249 <td>
 250                 <p>
 251                   <a class="link" href="posix__basic_stream_descriptor/get_io_service.html" title="posix::basic_stream_descriptor::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
 252                 </p>
 253               </td>
 254 <td>
 255                 <p>
 256                   Get the io_service associated with the object.
 257                 </p>
 258               </td>
 259 </tr>
 260 <tr>
 261 <td>
 262                 <p>
 263                   <a class="link" href="posix__basic_stream_descriptor/io_control.html" title="posix::basic_stream_descriptor::io_control"><span class="bold"><strong>io_control</strong></span></a>
 264                 </p>
 265               </td>
 266 <td>
 267                 <p>
 268                   Perform an IO control command on the descriptor.
 269                 </p>
 270               </td>
 271 </tr>
 272 <tr>
 273 <td>
 274                 <p>
 275                   <a class="link" href="posix__basic_stream_descriptor/is_open.html" title="posix::basic_stream_descriptor::is_open"><span class="bold"><strong>is_open</strong></span></a>
 276                 </p>
 277               </td>
 278 <td>
 279                 <p>
 280                   Determine whether the descriptor is open.
 281                 </p>
 282               </td>
 283 </tr>
 284 <tr>
 285 <td>
 286                 <p>
 287                   <a class="link" href="posix__basic_stream_descriptor/lowest_layer.html" title="posix::basic_stream_descriptor::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a>
 288                 </p>
 289               </td>
 290 <td>
 291                 <p>
 292                   Get a reference to the lowest layer.
 293                 </p>
 294                 <p>
 295                   Get a const reference to the lowest layer.
 296                 </p>
 297               </td>
 298 </tr>
 299 <tr>
 300 <td>
 301                 <p>
 302                   <a class="link" href="posix__basic_stream_descriptor/native.html" title="posix::basic_stream_descriptor::native"><span class="bold"><strong>native</strong></span></a>
 303                 </p>
 304               </td>
 305 <td>
 306                 <p>
 307                   (Deprecated: Use native_handle().) Get the native descriptor representation.
 308                 </p>
 309               </td>
 310 </tr>
 311 <tr>
 312 <td>
 313                 <p>
 314                   <a class="link" href="posix__basic_stream_descriptor/native_handle.html" title="posix::basic_stream_descriptor::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
 315                 </p>
 316               </td>
 317 <td>
 318                 <p>
 319                   Get the native descriptor representation.
 320                 </p>
 321               </td>
 322 </tr>
 323 <tr>
 324 <td>
 325                 <p>
 326                   <a class="link" href="posix__basic_stream_descriptor/native_non_blocking.html" title="posix::basic_stream_descriptor::native_non_blocking"><span class="bold"><strong>native_non_blocking</strong></span></a>
 327                 </p>
 328               </td>
 329 <td>
 330                 <p>
 331                   Gets the non-blocking mode of the native descriptor implementation.
 332                 </p>
 333                 <p>
 334                   Sets the non-blocking mode of the native descriptor implementation.
 335                 </p>
 336               </td>
 337 </tr>
 338 <tr>
 339 <td>
 340                 <p>
 341                   <a class="link" href="posix__basic_stream_descriptor/non_blocking.html" title="posix::basic_stream_descriptor::non_blocking"><span class="bold"><strong>non_blocking</strong></span></a>
 342                 </p>
 343               </td>
 344 <td>
 345                 <p>
 346                   Gets the non-blocking mode of the descriptor.
 347                 </p>
 348                 <p>
 349                   Sets the non-blocking mode of the descriptor.
 350                 </p>
 351               </td>
 352 </tr>
 353 <tr>
 354 <td>
 355                 <p>
 356                   <a class="link" href="posix__basic_stream_descriptor/operator_eq_.html" title="posix::basic_stream_descriptor::operator="><span class="bold"><strong>operator=</strong></span></a>
 357                 </p>
 358               </td>
 359 <td>
 360                 <p>
 361                   Move-assign a basic_stream_descriptor from another.
 362                 </p>
 363               </td>
 364 </tr>
 365 <tr>
 366 <td>
 367                 <p>
 368                   <a class="link" href="posix__basic_stream_descriptor/read_some.html" title="posix::basic_stream_descriptor::read_some"><span class="bold"><strong>read_some</strong></span></a>
 369                 </p>
 370               </td>
 371 <td>
 372                 <p>
 373                   Read some data from the descriptor.
 374                 </p>
 375               </td>
 376 </tr>
 377 <tr>
 378 <td>
 379                 <p>
 380                   <a class="link" href="posix__basic_stream_descriptor/release.html" title="posix::basic_stream_descriptor::release"><span class="bold"><strong>release</strong></span></a>
 381                 </p>
 382               </td>
 383 <td>
 384                 <p>
 385                   Release ownership of the native descriptor implementation.
 386                 </p>
 387               </td>
 388 </tr>
 389 <tr>
 390 <td>
 391                 <p>
 392                   <a class="link" href="posix__basic_stream_descriptor/write_some.html" title="posix::basic_stream_descriptor::write_some"><span class="bold"><strong>write_some</strong></span></a>
 393                 </p>
 394               </td>
 395 <td>
 396                 <p>
 397                   Write some data to the descriptor.
 398                 </p>
 399               </td>
 400 </tr>
 401 </tbody>
 402 </table></div>
 403 <h5>
 404 <a name="boost_asio.reference.posix__stream_descriptor.h2"></a>
 405         <span class="phrase"><a name="boost_asio.reference.posix__stream_descriptor.protected_member_functions"></a></span><a class="link" href="posix__stream_descriptor.html#boost_asio.reference.posix__stream_descriptor.protected_member_functions">Protected
 406         Member Functions</a>
 407       </h5>
 408 <div class="informaltable"><table class="table">
 409 <colgroup>
 410 <col>
 411 <col>
 412 </colgroup>
 413 <thead><tr>
 414 <th>
 415                 <p>
 416                   Name
 417                 </p>
 418               </th>
 419 <th>
 420                 <p>
 421                   Description
 422                 </p>
 423               </th>
 424 </tr></thead>
 425 <tbody>
 426 <tr>
 427 <td>
 428                 <p>
 429                   <a class="link" href="posix__basic_stream_descriptor/get_implementation.html" title="posix::basic_stream_descriptor::get_implementation"><span class="bold"><strong>get_implementation</strong></span></a>
 430                 </p>
 431               </td>
 432 <td>
 433                 <p>
 434                   Get the underlying implementation of the I/O object.
 435                 </p>
 436               </td>
 437 </tr>
 438 <tr>
 439 <td>
 440                 <p>
 441                   <a class="link" href="posix__basic_stream_descriptor/get_service.html" title="posix::basic_stream_descriptor::get_service"><span class="bold"><strong>get_service</strong></span></a>
 442                 </p>
 443               </td>
 444 <td>
 445                 <p>
 446                   Get the service associated with the I/O object.
 447                 </p>
 448               </td>
 449 </tr>
 450 </tbody>
 451 </table></div>
 452 <h5>
 453 <a name="boost_asio.reference.posix__stream_descriptor.h3"></a>
 454         <span class="phrase"><a name="boost_asio.reference.posix__stream_descriptor.protected_data_members"></a></span><a class="link" href="posix__stream_descriptor.html#boost_asio.reference.posix__stream_descriptor.protected_data_members">Protected
 455         Data Members</a>
 456       </h5>
 457 <div class="informaltable"><table class="table">
 458 <colgroup>
 459 <col>
 460 <col>
 461 </colgroup>
 462 <thead><tr>
 463 <th>
 464                 <p>
 465                   Name
 466                 </p>
 467               </th>
 468 <th>
 469                 <p>
 470                   Description
 471                 </p>
 472               </th>
 473 </tr></thead>
 474 <tbody>
 475 <tr>
 476 <td>
 477                 <p>
 478                   <a class="link" href="posix__basic_stream_descriptor/implementation.html" title="posix::basic_stream_descriptor::implementation"><span class="bold"><strong>implementation</strong></span></a>
 479                 </p>
 480               </td>
 481 <td>
 482                 <p>
 483                   (Deprecated: Use get_implementation().) The underlying implementation
 484                   of the I/O object.
 485                 </p>
 486               </td>
 487 </tr>
 488 <tr>
 489 <td>
 490                 <p>
 491                   <a class="link" href="posix__basic_stream_descriptor/service.html" title="posix::basic_stream_descriptor::service"><span class="bold"><strong>service</strong></span></a>
 492                 </p>
 493               </td>
 494 <td>
 495                 <p>
 496                   (Deprecated: Use get_service().) The service associated with the
 497                   I/O object.
 498                 </p>
 499               </td>
 500 </tr>
 501 </tbody>
 502 </table></div>
 503 <p>
 504         The <a class="link" href="posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"><code class="computeroutput"><span class="identifier">posix</span><span class="special">::</span><span class="identifier">basic_stream_descriptor</span></code></a> class template
 505         provides asynchronous and blocking stream-oriented descriptor functionality.
 506       </p>
 507 <h5>
 508 <a name="boost_asio.reference.posix__stream_descriptor.h4"></a>
 509         <span class="phrase"><a name="boost_asio.reference.posix__stream_descriptor.thread_safety"></a></span><a class="link" href="posix__stream_descriptor.html#boost_asio.reference.posix__stream_descriptor.thread_safety">Thread
 510         Safety</a>
 511       </h5>
 512 <p>
 513         <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
 514       </p>
 515 <p>
 516         <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
 517       </p>
 518 <h5>
 519 <a name="boost_asio.reference.posix__stream_descriptor.h5"></a>
 520         <span class="phrase"><a name="boost_asio.reference.posix__stream_descriptor.requirements"></a></span><a class="link" href="posix__stream_descriptor.html#boost_asio.reference.posix__stream_descriptor.requirements">Requirements</a>
 521       </h5>
 522 <p>
 523         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/posix/stream_descriptor.hpp</code>
 524       </p>
 525 <p>
 526         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 527       </p>
 528 </div>
 529 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 530 <td align="left"></td>
 531 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
 532         Distributed under the Boost Software License, Version 1.0. (See accompanying
 533         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>)
 534       </p>
 535 </div></td>
 536 </tr></table>
 537 <hr>
 538 <div class="spirit-nav">
 539 <a accesskey="p" href="posix__descriptor_base/_descriptor_base.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="posix__stream_descriptor_service.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 540 </div>
 541 </body>
 542 </html>