• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>basic_stream_socket::available (1 of 2 overloads)</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="../available.html" title="basic_stream_socket::available">
9<link rel="prev" href="../available.html" title="basic_stream_socket::available">
10<link rel="next" href="overload2.html" title="basic_stream_socket::available (2 of 2 overloads)">
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="../available.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../available.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h5 class="title">
27<a name="boost_asio.reference.basic_stream_socket.available.overload1"></a><a class="link" href="overload1.html" title="basic_stream_socket::available (1 of 2 overloads)">basic_stream_socket::available
28          (1 of 2 overloads)</a>
29</h5></div></div></div>
30<p>
31            <span class="emphasis"><em>Inherited from basic_socket.</em></span>
32          </p>
33<p>
34            Determine the number of bytes available for reading.
35          </p>
36<pre class="programlisting">std::size_t available() const;
37</pre>
38<p>
39            This function is used to determine the number of bytes that may be read
40            without blocking.
41          </p>
42<h6>
43<a name="boost_asio.reference.basic_stream_socket.available.overload1.h0"></a>
44            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.available.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.available.overload1.return_value">Return
45            Value</a>
46          </h6>
47<p>
48            The number of bytes that may be read without blocking, or 0 if an error
49            occurs.
50          </p>
51<h6>
52<a name="boost_asio.reference.basic_stream_socket.available.overload1.h1"></a>
53            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.available.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.available.overload1.exceptions">Exceptions</a>
54          </h6>
55<div class="variablelist">
56<p class="title"><b></b></p>
57<dl class="variablelist">
58<dt><span class="term">boost::system::system_error</span></dt>
59<dd><p>
60                  Thrown on failure.
61                </p></dd>
62</dl>
63</div>
64</div>
65<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
66<td align="left"></td>
67<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
68      Kohlhoff<p>
69        Distributed under the Boost Software License, Version 1.0. (See accompanying
70        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>)
71      </p>
72</div></td>
73</tr></table>
74<hr>
75<div class="spirit-nav">
76<a accesskey="p" href="../available.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../available.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
77</div>
78</body>
79</html>
80