185 lines
9.4 KiB
HTML
185 lines
9.4 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>async_read_until (6 of 12 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="../async_read_until.html" title="async_read_until">
|
|
<link rel="prev" href="overload5.html" title="async_read_until (5 of 12 overloads)">
|
|
<link rel="next" href="overload7.html" title="async_read_until (7 of 12 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="overload5.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_read_until.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="overload7.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.async_read_until.overload6"></a><a class="link" href="overload6.html" title="async_read_until (6 of 12 overloads)">async_read_until
|
|
(6 of 12 overloads)</a>
|
|
</h4></div></div></div>
|
|
<p>
|
|
Start an asynchronous operation to read data into a streambuf until it
|
|
contains a specified delimiter.
|
|
</p>
|
|
<pre class="programlisting">template<
|
|
typename <a class="link" href="../AsyncReadStream.html" title="Buffer-oriented asynchronous read stream requirements">AsyncReadStream</a>,
|
|
typename Allocator,
|
|
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.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></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_until(
|
|
AsyncReadStream & s,
|
|
boost::asio::basic_streambuf< Allocator > & b,
|
|
string_view delim,
|
|
ReadHandler && handler = <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
|
|
</pre>
|
|
<p>
|
|
This function is used to asynchronously read data into the specified streambuf
|
|
until the streambuf's get area contains the specified delimiter. The function
|
|
call always returns immediately. The asynchronous operation will continue
|
|
until one of the following conditions is true:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
|
|
<li class="listitem">
|
|
The get area of the streambuf contains the specified delimiter.
|
|
</li>
|
|
<li class="listitem">
|
|
An error occurred.
|
|
</li>
|
|
</ul></div>
|
|
<p>
|
|
This operation is implemented in terms of zero or more calls to the stream's
|
|
async_read_some function, and is known as a <span class="emphasis"><em>composed operation</em></span>.
|
|
If the streambuf's get area already contains the delimiter, this asynchronous
|
|
operation completes immediately. The program must ensure that the stream
|
|
performs no other read operations (such as async_read, async_read_until,
|
|
the stream's async_read_some function, or any other composed operations
|
|
that perform reads) until this operation completes.
|
|
</p>
|
|
<h6>
|
|
<a name="boost_asio.reference.async_read_until.overload6.h0"></a>
|
|
<span class="phrase"><a name="boost_asio.reference.async_read_until.overload6.parameters"></a></span><a class="link" href="overload6.html#boost_asio.reference.async_read_until.overload6.parameters">Parameters</a>
|
|
</h6>
|
|
<div class="variablelist">
|
|
<p class="title"><b></b></p>
|
|
<dl class="variablelist">
|
|
<dt><span class="term">s</span></dt>
|
|
<dd><p>
|
|
The stream from which the data is to be read. The type must support
|
|
the AsyncReadStream concept.
|
|
</p></dd>
|
|
<dt><span class="term">b</span></dt>
|
|
<dd><p>
|
|
A streambuf object into which the data will be read. Ownership of
|
|
the streambuf is retained by the caller, which must guarantee that
|
|
it remains valid until the handler is called.
|
|
</p></dd>
|
|
<dt><span class="term">delim</span></dt>
|
|
<dd><p>
|
|
The delimiter string.
|
|
</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(
|
|
// Result of operation.
|
|
const boost::system::error_code& error,
|
|
|
|
// The number of bytes in the streambuf's get
|
|
// area up to and including the delimiter.
|
|
// 0 if an error occurred.
|
|
std::size_t bytes_transferred
|
|
);
|
|
</pre>
|
|
<p>
|
|
Regardless of whether the asynchronous operation completes immediately
|
|
or not, the handler will not be invoked from within this function.
|
|
On immediate completion, invocation of the handler will be performed
|
|
in a manner equivalent to using <a class="link" href="../post.html" title="post"><code class="computeroutput">post</code></a>.
|
|
</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h6>
|
|
<a name="boost_asio.reference.async_read_until.overload6.h1"></a>
|
|
<span class="phrase"><a name="boost_asio.reference.async_read_until.overload6.remarks"></a></span><a class="link" href="overload6.html#boost_asio.reference.async_read_until.overload6.remarks">Remarks</a>
|
|
</h6>
|
|
<p>
|
|
After a successful async_read_until operation, the streambuf may contain
|
|
additional data beyond the delimiter. An application will typically leave
|
|
that data in the streambuf for a subsequent async_read_until operation
|
|
to examine.
|
|
</p>
|
|
<h6>
|
|
<a name="boost_asio.reference.async_read_until.overload6.h2"></a>
|
|
<span class="phrase"><a name="boost_asio.reference.async_read_until.overload6.example"></a></span><a class="link" href="overload6.html#boost_asio.reference.async_read_until.overload6.example">Example</a>
|
|
</h6>
|
|
<p>
|
|
To asynchronously read data into a streambuf until a newline is encountered:
|
|
</p>
|
|
<pre class="programlisting">boost::asio::streambuf b;
|
|
...
|
|
void handler(const boost::system::error_code& e, std::size_t size)
|
|
{
|
|
if (!e)
|
|
{
|
|
std::istream is(&b);
|
|
std::string line;
|
|
std::getline(is, line);
|
|
...
|
|
}
|
|
}
|
|
...
|
|
boost::asio::async_read_until(s, b, "\r\n", handler);
|
|
</pre>
|
|
<p>
|
|
After the <code class="computeroutput">async_read_until</code> operation completes successfully,
|
|
the buffer <code class="computeroutput">b</code> contains the delimiter:
|
|
</p>
|
|
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
|
|
</pre>
|
|
<p>
|
|
The call to <code class="computeroutput">std::getline</code> then extracts the data up to and
|
|
including the newline (which is discarded), so that the string <code class="computeroutput">line</code>
|
|
contains:
|
|
</p>
|
|
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\r' }
|
|
</pre>
|
|
<p>
|
|
The remaining data is left in the buffer <code class="computeroutput">b</code> as follows:
|
|
</p>
|
|
<pre class="programlisting">{ 'd', 'e', ... }
|
|
</pre>
|
|
<p>
|
|
This data may be the start of a new line, to be extracted by a subsequent
|
|
<code class="computeroutput">async_read_until</code> operation.
|
|
</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="overload5.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_read_until.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="overload7.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|