doc/html/boost_asio/reference/posix__basic_stream_descriptor.html

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