[DEV] add v1.76.0

This commit is contained in:
2021-10-05 21:37:46 +02:00
parent a97e9ae7d4
commit d0115b733d
45133 changed files with 4744437 additions and 1026325 deletions

View File

@@ -0,0 +1,118 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_stream_socket::receive (1 of 3 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="../receive.html" title="basic_stream_socket::receive">
<link rel="prev" href="../receive.html" title="basic_stream_socket::receive">
<link rel="next" href="overload2.html" title="basic_stream_socket::receive (2 of 3 overloads)">
</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="../receive.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../receive.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>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.basic_stream_socket.receive.overload1"></a><a class="link" href="overload1.html" title="basic_stream_socket::receive (1 of 3 overloads)">basic_stream_socket::receive
(1 of 3 overloads)</a>
</h5></div></div></div>
<p>
Receive some data on 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 receive(
const MutableBufferSequence &amp; buffers);
</pre>
<p>
This function is used to receive data on the stream socket. The function
call will block until one or more bytes of data has been received successfully,
or until an error occurs.
</p>
<h6>
<a name="boost_asio.reference.basic_stream_socket.receive.overload1.h0"></a>
<span class="phrase"><a name="boost_asio.reference.basic_stream_socket.receive.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.receive.overload1.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 received.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.basic_stream_socket.receive.overload1.h1"></a>
<span class="phrase"><a name="boost_asio.reference.basic_stream_socket.receive.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.receive.overload1.return_value">Return
Value</a>
</h6>
<p>
The number of bytes received.
</p>
<h6>
<a name="boost_asio.reference.basic_stream_socket.receive.overload1.h2"></a>
<span class="phrase"><a name="boost_asio.reference.basic_stream_socket.receive.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.receive.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">boost::system::system_error</span></dt>
<dd><p>
Thrown on failure. An error code of <code class="computeroutput">boost::asio::error::eof</code>
indicates that the connection was closed by the peer.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.basic_stream_socket.receive.overload1.h3"></a>
<span class="phrase"><a name="boost_asio.reference.basic_stream_socket.receive.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.receive.overload1.remarks">Remarks</a>
</h6>
<p>
The receive operation may not receive 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>
<h6>
<a name="boost_asio.reference.basic_stream_socket.receive.overload1.h4"></a>
<span class="phrase"><a name="boost_asio.reference.basic_stream_socket.receive.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.receive.overload1.example">Example</a>
</h6>
<p>
To receive into a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
function as follows:
</p>
<pre class="programlisting">socket.receive(boost::asio::buffer(data, size));
</pre>
<p>
See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
documentation for information on receiving into multiple buffers in one
go, and how to use it with arrays, boost::array or std::vector.
</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 © 2003-2021 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="../receive.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../receive.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>
</div>
</body>
</html>

View File

@@ -0,0 +1,123 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_stream_socket::receive (2 of 3 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="../receive.html" title="basic_stream_socket::receive">
<link rel="prev" href="overload1.html" title="basic_stream_socket::receive (1 of 3 overloads)">
<link rel="next" href="overload3.html" title="basic_stream_socket::receive (3 of 3 overloads)">
</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="../receive.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="overload3.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.receive.overload2"></a><a class="link" href="overload2.html" title="basic_stream_socket::receive (2 of 3 overloads)">basic_stream_socket::receive
(2 of 3 overloads)</a>
</h5></div></div></div>
<p>
Receive some data on 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 receive(
const MutableBufferSequence &amp; buffers,
socket_base::message_flags flags);
</pre>
<p>
This function is used to receive data on the stream socket. The function
call will block until one or more bytes of data has been received successfully,
or until an error occurs.
</p>
<h6>
<a name="boost_asio.reference.basic_stream_socket.receive.overload2.h0"></a>
<span class="phrase"><a name="boost_asio.reference.basic_stream_socket.receive.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.receive.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 received.
</p></dd>
<dt><span class="term">flags</span></dt>
<dd><p>
Flags specifying how the receive call is to be made.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.basic_stream_socket.receive.overload2.h1"></a>
<span class="phrase"><a name="boost_asio.reference.basic_stream_socket.receive.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.receive.overload2.return_value">Return
Value</a>
</h6>
<p>
The number of bytes received.
</p>
<h6>
<a name="boost_asio.reference.basic_stream_socket.receive.overload2.h2"></a>
<span class="phrase"><a name="boost_asio.reference.basic_stream_socket.receive.overload2.exceptions"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.receive.overload2.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">boost::system::system_error</span></dt>
<dd><p>
Thrown on failure. An error code of <code class="computeroutput">boost::asio::error::eof</code>
indicates that the connection was closed by the peer.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.basic_stream_socket.receive.overload2.h3"></a>
<span class="phrase"><a name="boost_asio.reference.basic_stream_socket.receive.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.receive.overload2.remarks">Remarks</a>
</h6>
<p>
The receive operation may not receive 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>
<h6>
<a name="boost_asio.reference.basic_stream_socket.receive.overload2.h4"></a>
<span class="phrase"><a name="boost_asio.reference.basic_stream_socket.receive.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.receive.overload2.example">Example</a>
</h6>
<p>
To receive into a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
function as follows:
</p>
<pre class="programlisting">socket.receive(boost::asio::buffer(data, size), 0);
</pre>
<p>
See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
documentation for information on receiving into multiple buffers in one
go, and how to use it with arrays, boost::array or std::vector.
</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 © 2003-2021 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="../receive.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="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@@ -0,0 +1,99 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_stream_socket::receive (3 of 3 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="../receive.html" title="basic_stream_socket::receive">
<link rel="prev" href="overload2.html" title="basic_stream_socket::receive (2 of 3 overloads)">
<link rel="next" href="../receive_buffer_size.html" title="basic_stream_socket::receive_buffer_size">
</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="overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../receive.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_buffer_size.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.receive.overload3"></a><a class="link" href="overload3.html" title="basic_stream_socket::receive (3 of 3 overloads)">basic_stream_socket::receive
(3 of 3 overloads)</a>
</h5></div></div></div>
<p>
Receive some data on a connected 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 receive(
const MutableBufferSequence &amp; buffers,
socket_base::message_flags flags,
boost::system::error_code &amp; ec);
</pre>
<p>
This function is used to receive data on the stream socket. The function
call will block until one or more bytes of data has been received successfully,
or until an error occurs.
</p>
<h6>
<a name="boost_asio.reference.basic_stream_socket.receive.overload3.h0"></a>
<span class="phrase"><a name="boost_asio.reference.basic_stream_socket.receive.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_stream_socket.receive.overload3.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 received.
</p></dd>
<dt><span class="term">flags</span></dt>
<dd><p>
Flags specifying how the receive call is to be made.
</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.receive.overload3.h1"></a>
<span class="phrase"><a name="boost_asio.reference.basic_stream_socket.receive.overload3.return_value"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_stream_socket.receive.overload3.return_value">Return
Value</a>
</h6>
<p>
The number of bytes received. Returns 0 if an error occurred.
</p>
<h6>
<a name="boost_asio.reference.basic_stream_socket.receive.overload3.h2"></a>
<span class="phrase"><a name="boost_asio.reference.basic_stream_socket.receive.overload3.remarks"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_stream_socket.receive.overload3.remarks">Remarks</a>
</h6>
<p>
The receive operation may not receive 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 © 2003-2021 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="overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../receive.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_buffer_size.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>