diff options
Diffstat (limited to 'doc/html/boost_asio/reference/posix__stream_descriptor/async_read_some.html')
| -rw-r--r-- | doc/html/boost_asio/reference/posix__stream_descriptor/async_read_some.html | 119 |
1 files changed, 0 insertions, 119 deletions
diff --git a/doc/html/boost_asio/reference/posix__stream_descriptor/async_read_some.html b/doc/html/boost_asio/reference/posix__stream_descriptor/async_read_some.html deleted file mode 100644 index a9694126ce..0000000000 --- a/doc/html/boost_asio/reference/posix__stream_descriptor/async_read_some.html +++ /dev/null @@ -1,119 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>posix::stream_descriptor::async_read_some</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="../posix__stream_descriptor.html" title="posix::stream_descriptor"> -<link rel="prev" href="assign/overload2.html" title="posix::stream_descriptor::assign (2 of 2 overloads)"> -<link rel="next" href="async_wait.html" title="posix::stream_descriptor::async_wait"> -</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="assign/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__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="async_wait.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="section"> -<div class="titlepage"><div><div><h4 class="title"> -<a name="boost_asio.reference.posix__stream_descriptor.async_read_some"></a><a class="link" href="async_read_some.html" title="posix::stream_descriptor::async_read_some">posix::stream_descriptor::async_read_some</a> -</h4></div></div></div> -<p> - <a class="indexterm" name="boost_asio.indexterm.posix__stream_descriptor.async_read_some"></a> -Start - an asynchronous read. - </p> -<pre class="programlisting">template< - typename <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>, - typename <a class="link" href="../ReadHandler.html" title="Read handler requirements">ReadHandler</a>> -<a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_read_some( - const MutableBufferSequence & buffers, - ReadHandler && handler); -</pre> -<p> - This function is used to asynchronously read data from the stream descriptor. - The function call always returns immediately. - </p> -<h6> -<a name="boost_asio.reference.posix__stream_descriptor.async_read_some.h0"></a> - <span class="phrase"><a name="boost_asio.reference.posix__stream_descriptor.async_read_some.parameters"></a></span><a class="link" href="async_read_some.html#boost_asio.reference.posix__stream_descriptor.async_read_some.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. Although the - buffers object may be copied as necessary, ownership of the underlying - memory blocks is retained by the caller, which must guarantee that - they remain valid until the handler is called. - </p></dd> -<dt><span class="term">handler</span></dt> -<dd> -<p> - The handler to be called when the read operation completes. Copies - will be made of the handler as required. The function signature of - the handler must be: -</p> -<pre class="programlisting">void handler( - const boost::system::error_code& error, // Result of operation. - std::size_t bytes_transferred // Number of bytes read. -); -</pre> -<p> - Regardless of whether the asynchronous operation completes immediately - or not, the handler will not be invoked from within this function. - Invocation of the handler will be performed in a manner equivalent - to using <code class="computeroutput">boost::asio::io_context::post()</code>. - </p> -</dd> -</dl> -</div> -<h6> -<a name="boost_asio.reference.posix__stream_descriptor.async_read_some.h1"></a> - <span class="phrase"><a name="boost_asio.reference.posix__stream_descriptor.async_read_some.remarks"></a></span><a class="link" href="async_read_some.html#boost_asio.reference.posix__stream_descriptor.async_read_some.remarks">Remarks</a> - </h6> -<p> - The read operation may not read all of the requested number of bytes. Consider - using the <a class="link" href="../async_read.html" title="async_read"><code class="computeroutput">async_read</code></a> - function if you need to ensure that the requested amount of data is read - before the asynchronous operation completes. - </p> -<h6> -<a name="boost_asio.reference.posix__stream_descriptor.async_read_some.h2"></a> - <span class="phrase"><a name="boost_asio.reference.posix__stream_descriptor.async_read_some.example"></a></span><a class="link" href="async_read_some.html#boost_asio.reference.posix__stream_descriptor.async_read_some.example">Example</a> - </h6> -<p> - To read 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">descriptor.async_read_some(boost::asio::buffer(data, size), handler); -</pre> -<p> - See the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a> - documentation for information on reading 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-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="assign/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__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="async_wait.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> |