• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>posix::basic_stream_descriptor::bytes_readable</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="basic_stream_descriptor/overload5.html" title="posix::basic_stream_descriptor::basic_stream_descriptor (5 of 5 overloads)">
10<link rel="next" href="cancel.html" title="posix::basic_stream_descriptor::cancel">
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="basic_stream_descriptor/overload5.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="cancel.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.bytes_readable"></a><a class="link" href="bytes_readable.html" title="posix::basic_stream_descriptor::bytes_readable">posix::basic_stream_descriptor::bytes_readable</a>
28</h4></div></div></div>
29<p>
30          <span class="emphasis"><em>Inherited from posix::descriptor_base.</em></span>
31        </p>
32<p>
33          <a class="indexterm" name="boost_asio.indexterm.posix__basic_stream_descriptor.bytes_readable"></a>
34IO
35          control command to get the amount of data that can be read without blocking.
36        </p>
37<pre class="programlisting">typedef implementation_defined bytes_readable;
38</pre>
39<p>
40          Implements the FIONREAD IO control command.
41        </p>
42<h6>
43<a name="boost_asio.reference.posix__basic_stream_descriptor.bytes_readable.h0"></a>
44          <span class="phrase"><a name="boost_asio.reference.posix__basic_stream_descriptor.bytes_readable.example"></a></span><a class="link" href="bytes_readable.html#boost_asio.reference.posix__basic_stream_descriptor.bytes_readable.example">Example</a>
45        </h6>
46<pre class="programlisting">boost::asio::posix::stream_descriptor descriptor(my_context);
47...
48boost::asio::descriptor_base::bytes_readable command(true);
49descriptor.io_control(command);
50std::size_t bytes_readable = command.get();
51</pre>
52<h6>
53<a name="boost_asio.reference.posix__basic_stream_descriptor.bytes_readable.h1"></a>
54          <span class="phrase"><a name="boost_asio.reference.posix__basic_stream_descriptor.bytes_readable.requirements"></a></span><a class="link" href="bytes_readable.html#boost_asio.reference.posix__basic_stream_descriptor.bytes_readable.requirements">Requirements</a>
55        </h6>
56<p>
57          <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/posix/basic_stream_descriptor.hpp</code>
58        </p>
59<p>
60          <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
61        </p>
62</div>
63<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
64<td align="left"></td>
65<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
66      Kohlhoff<p>
67        Distributed under the Boost Software License, Version 1.0. (See accompanying
68        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>)
69      </p>
70</div></td>
71</tr></table>
72<hr>
73<div class="spirit-nav">
74<a accesskey="p" href="basic_stream_descriptor/overload5.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="cancel.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
75</div>
76</body>
77</html>
78