doc/html/boost_asio/reference/basic_stream_socket/read_some/overload2.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>basic_stream_socket::read_some (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../read_some.html" title="basic_stream_socket::read_some">
<link rel="prev" href="overload1.html" title="basic_stream_socket::read_some (1 of 2 overloads)">
<link rel="next" href="../receive.html" title="basic_stream_socket::receive">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.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="../receive.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.basic_stream_socket.read_some.overload2"></a><a class="link" href="overload2.html" title="basic_stream_socket::read_some (2 of 2 overloads)">basic_stream_socket::read_some
          (2 of 2 overloads)</a>
</h5></div></div></div>
<p>
            Read some data from the socket.
          </p>
<pre class="programlisting">template&lt;
    typename <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>&gt;
std::size_t read_some(
    const MutableBufferSequence &amp; buffers,
    boost::system::error_code &amp; ec);
</pre>
<p>
            This function is used to read data from the stream socket. The function
            call will block until one or more bytes of data has been read successfully,
            or until an error occurs.
          </p>
<h6>
<a name="boost_asio.reference.basic_stream_socket.read_some.overload2.h0"></a>
            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.read_some.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.read_some.overload2.parameters">Parameters</a>
          </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">buffers</span></dt>
<dd><p>
                  One or more buffers into which the data will be read.
                </p></dd>
<dt><span class="term">ec</span></dt>
<dd><p>
                  Set to indicate what error occurred, if any.
                </p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.basic_stream_socket.read_some.overload2.h1"></a>
            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.read_some.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.read_some.overload2.return_value">Return
            Value</a>
          </h6>
<p>
            The number of bytes read. Returns 0 if an error occurred.
          </p>
<h6>
<a name="boost_asio.reference.basic_stream_socket.read_some.overload2.h2"></a>
            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.read_some.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.read_some.overload2.remarks">Remarks</a>
          </h6>
<p>
            The read_some operation may not read all of the requested number of bytes.
            Consider using the <a class="link" href="../../read.html" title="read"><code class="computeroutput">read</code></a>
            function if you need to ensure that the requested amount of data is read
            before the blocking operation completes.
          </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2018 Christopher M. Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.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="../receive.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>