doc/html/boost_asio/reference/socket_base/bytes_readable.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>socket_base::bytes_readable</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="../socket_base.html" title="socket_base">
   9 <link rel="prev" href="broadcast.html" title="socket_base::broadcast">
  10 <link rel="next" href="debug.html" title="socket_base::debug">
  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="broadcast.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../socket_base.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="debug.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.socket_base.bytes_readable"></a><a class="link" href="bytes_readable.html" title="socket_base::bytes_readable">socket_base::bytes_readable</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idp192861920"></a>
  31 IO control command to get the amount of data that
  32           can be read without blocking.
  33         </p>
  34 <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">bytes_readable</span><span class="special">;</span>
  35 </pre>
  36 <p>
  37           Implements the FIONREAD IO control command.
  38         </p>
  39 <h6>
  40 <a name="boost_asio.reference.socket_base.bytes_readable.h0"></a>
  41           <span class="phrase"><a name="boost_asio.reference.socket_base.bytes_readable.example"></a></span><a class="link" href="bytes_readable.html#boost_asio.reference.socket_base.bytes_readable.example">Example</a>
  42         </h6>
  43 <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span>
  44 <span class="special">...</span>
  45 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">socket_base</span><span class="special">::</span><span class="identifier">bytes_readable</span> <span class="identifier">command</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span>
  46 <span class="identifier">socket</span><span class="special">.</span><span class="identifier">io_control</span><span class="special">(</span><span class="identifier">command</span><span class="special">);</span>
  47 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_readable</span> <span class="special">=</span> <span class="identifier">command</span><span class="special">.</span><span class="identifier">get</span><span class="special">();</span>
  48 </pre>
  49 <h6>
  50 <a name="boost_asio.reference.socket_base.bytes_readable.h1"></a>
  51           <span class="phrase"><a name="boost_asio.reference.socket_base.bytes_readable.requirements"></a></span><a class="link" href="bytes_readable.html#boost_asio.reference.socket_base.bytes_readable.requirements">Requirements</a>
  52         </h6>
  53 <p>
  54           <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/socket_base.hpp</code>
  55         </p>
  56 <p>
  57           <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
  58         </p>
  59 </div>
  60 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  61 <td align="left"></td>
  62 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  63         Distributed under the Boost Software License, Version 1.0. (See accompanying
  64         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>)
  65       </p>
  66 </div></td>
  67 </tr></table>
  68 <hr>
  69 <div class="spirit-nav">
  70 <a accesskey="p" href="broadcast.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../socket_base.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="debug.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  71 </div>
  72 </body>
  73 </html>