Adds asio library and Storage Module
This commit is contained in:
1 parent
79a6ee5779
commit
30439acd43
4869 files changed
+618801
-903
No files matched your search
@@ -0,0 +1,159 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (1 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="../read_until.html" title="read_until">
|
||||
<link rel="next" href="overload2.html" title="read_until (2 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="../read_until.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload1"></a><a class="link" href="overload1.html" title="read_until (1 of 24 overloads)">read_until (1
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a dynamic buffer sequence until it contains a specified
|
||||
delimiter.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename <a class="link" href="../DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
DynamicBuffer_v1 && buffers,
|
||||
char delim,
|
||||
typename enable_if< is_dynamic_buffer_v1< typename decay< DynamicBuffer_v1 >::type >::value &&!is_dynamic_buffer_v2< typename decay< DynamicBuffer_v1 >::type >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified dynamic buffer sequence
|
||||
until the dynamic buffer sequence's get area contains the specified delimiter.
|
||||
The call will block until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
The get area of the dynamic buffer sequence 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
|
||||
read_some function. If the dynamic buffer sequence's get area already contains
|
||||
the delimiter, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload1.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload1.parameters"></a></span><a class="link" href="overload1.html#asio.reference.read_until.overload1.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">buffers</span></dt>
|
||||
<dd><p>
|
||||
The dynamic buffer sequence into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">delim</span></dt>
|
||||
<dd><p>
|
||||
The delimiter character.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload1.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload1.return_value"></a></span><a class="link" href="overload1.html#asio.reference.read_until.overload1.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the dynamic buffer sequence's get area up to and
|
||||
including the delimiter.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload1.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.read_until.overload1.exceptions">Exceptions</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">asio::system_error</span></dt>
|
||||
<dd><p>
|
||||
Thrown on failure.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload1.h3"></a>
|
||||
<span><a name="asio.reference.read_until.overload1.remarks"></a></span><a class="link" href="overload1.html#asio.reference.read_until.overload1.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the dynamic buffer sequence may
|
||||
contain additional data beyond the delimiter. An application will typically
|
||||
leave that data in the dynamic buffer sequence for a subsequent read_until
|
||||
operation to examine.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload1.h4"></a>
|
||||
<span><a name="asio.reference.read_until.overload1.example"></a></span><a class="link" href="overload1.html#asio.reference.read_until.overload1.example">Example</a>
|
||||
</h6>
|
||||
<p>
|
||||
To read data into a <code class="computeroutput">std::string</code> until a newline is encountered:
|
||||
</p>
|
||||
<pre class="programlisting">std::string data;
|
||||
std::size_t n = asio::read_until(s,
|
||||
asio::dynamic_buffer(data), '\n');
|
||||
std::string line = data.substr(0, n);
|
||||
data.erase(0, n);
|
||||
</pre>
|
||||
<p>
|
||||
After the <code class="computeroutput">read_until</code> operation completes successfully, the
|
||||
string <code class="computeroutput">data</code> contains the delimiter:
|
||||
</p>
|
||||
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\n', 'd', 'e', ... }
|
||||
</pre>
|
||||
<p>
|
||||
The call to <code class="computeroutput">substr</code> then extracts the data up to and including
|
||||
the delimiter, so that the string <code class="computeroutput">line</code> contains:
|
||||
</p>
|
||||
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\n' }
|
||||
</pre>
|
||||
<p>
|
||||
After the call to <code class="computeroutput">erase</code>, 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">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-2020 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="../read_until.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,112 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (10 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload9.html" title="read_until (9 of 24 overloads)">
|
||||
<link rel="next" href="overload11.html" title="read_until (11 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload9.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload11.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload10"></a><a class="link" href="overload10.html" title="read_until (10 of 24 overloads)">read_until (10
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a streambuf until it contains a specified delimiter.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename Allocator>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
asio::basic_streambuf< Allocator > & b,
|
||||
char delim,
|
||||
asio::error_code & ec);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified streambuf until the
|
||||
streambuf's get area contains the specified delimiter. The call will block
|
||||
until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" 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
|
||||
read_some function. If the streambuf's get area already contains the delimiter,
|
||||
the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload10.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload10.parameters"></a></span><a class="link" href="overload10.html#asio.reference.read_until.overload10.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">b</span></dt>
|
||||
<dd><p>
|
||||
A streambuf object into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">delim</span></dt>
|
||||
<dd><p>
|
||||
The delimiter character.
|
||||
</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="asio.reference.read_until.overload10.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload10.return_value"></a></span><a class="link" href="overload10.html#asio.reference.read_until.overload10.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the streambuf's get area up to and including the
|
||||
delimiter. Returns 0 if an error occurred.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload10.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload10.remarks"></a></span><a class="link" href="overload10.html#asio.reference.read_until.overload10.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful 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 read_until operation to examine.
|
||||
</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-2020 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="overload9.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload11.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,155 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (11 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload10.html" title="read_until (10 of 24 overloads)">
|
||||
<link rel="next" href="overload12.html" title="read_until (12 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload10.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload12.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload11"></a><a class="link" href="overload11.html" title="read_until (11 of 24 overloads)">read_until (11
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a streambuf until it contains a specified delimiter.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename Allocator>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
asio::basic_streambuf< Allocator > & b,
|
||||
string_view delim);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified streambuf until the
|
||||
streambuf's get area contains the specified delimiter. The call will block
|
||||
until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" 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
|
||||
read_some function. If the streambuf's get area already contains the delimiter,
|
||||
the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload11.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload11.parameters"></a></span><a class="link" href="overload11.html#asio.reference.read_until.overload11.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">b</span></dt>
|
||||
<dd><p>
|
||||
A streambuf object into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">delim</span></dt>
|
||||
<dd><p>
|
||||
The delimiter string.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload11.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload11.return_value"></a></span><a class="link" href="overload11.html#asio.reference.read_until.overload11.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the streambuf's get area up to and including the
|
||||
delimiter.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload11.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload11.exceptions"></a></span><a class="link" href="overload11.html#asio.reference.read_until.overload11.exceptions">Exceptions</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">asio::system_error</span></dt>
|
||||
<dd><p>
|
||||
Thrown on failure.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload11.h3"></a>
|
||||
<span><a name="asio.reference.read_until.overload11.remarks"></a></span><a class="link" href="overload11.html#asio.reference.read_until.overload11.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful 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 read_until operation to examine.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload11.h4"></a>
|
||||
<span><a name="asio.reference.read_until.overload11.example"></a></span><a class="link" href="overload11.html#asio.reference.read_until.overload11.example">Example</a>
|
||||
</h6>
|
||||
<p>
|
||||
To read data into a streambuf until a newline is encountered:
|
||||
</p>
|
||||
<pre class="programlisting">asio::streambuf b;
|
||||
asio::read_until(s, b, "\r\n");
|
||||
std::istream is(&b);
|
||||
std::string line;
|
||||
std::getline(is, line);
|
||||
</pre>
|
||||
<p>
|
||||
After the <code class="computeroutput">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">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-2020 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="overload10.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload12.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,112 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (12 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload11.html" title="read_until (11 of 24 overloads)">
|
||||
<link rel="next" href="overload13.html" title="read_until (13 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload11.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload13.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload12"></a><a class="link" href="overload12.html" title="read_until (12 of 24 overloads)">read_until (12
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a streambuf until it contains a specified delimiter.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename Allocator>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
asio::basic_streambuf< Allocator > & b,
|
||||
string_view delim,
|
||||
asio::error_code & ec);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified streambuf until the
|
||||
streambuf's get area contains the specified delimiter. The call will block
|
||||
until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" 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
|
||||
read_some function. If the streambuf's get area already contains the delimiter,
|
||||
the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload12.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload12.parameters"></a></span><a class="link" href="overload12.html#asio.reference.read_until.overload12.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">b</span></dt>
|
||||
<dd><p>
|
||||
A streambuf object into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">delim</span></dt>
|
||||
<dd><p>
|
||||
The delimiter string.
|
||||
</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="asio.reference.read_until.overload12.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload12.return_value"></a></span><a class="link" href="overload12.html#asio.reference.read_until.overload12.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the streambuf's get area up to and including the
|
||||
delimiter. Returns 0 if an error occurred.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload12.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload12.remarks"></a></span><a class="link" href="overload12.html#asio.reference.read_until.overload12.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful 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 read_until operation to examine.
|
||||
</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-2020 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="overload11.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload13.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,157 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (13 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload12.html" title="read_until (12 of 24 overloads)">
|
||||
<link rel="next" href="overload14.html" title="read_until (14 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload12.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload14.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload13"></a><a class="link" href="overload13.html" title="read_until (13 of 24 overloads)">read_until (13
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a streambuf until some part of the data it contains matches
|
||||
a regular expression.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename Allocator>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
asio::basic_streambuf< Allocator > & b,
|
||||
const boost::regex & expr);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified streambuf until the
|
||||
streambuf's get area contains some data that matches a regular expression.
|
||||
The call will block until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
A substring of the streambuf's get area matches the regular expression.
|
||||
</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
|
||||
read_some function. If the streambuf's get area already contains data that
|
||||
matches the regular expression, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload13.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload13.parameters"></a></span><a class="link" href="overload13.html#asio.reference.read_until.overload13.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">b</span></dt>
|
||||
<dd><p>
|
||||
A streambuf object into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">expr</span></dt>
|
||||
<dd><p>
|
||||
The regular expression.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload13.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload13.return_value"></a></span><a class="link" href="overload13.html#asio.reference.read_until.overload13.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the streambuf's get area up to and including the
|
||||
substring that matches the regular expression.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload13.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload13.exceptions"></a></span><a class="link" href="overload13.html#asio.reference.read_until.overload13.exceptions">Exceptions</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">asio::system_error</span></dt>
|
||||
<dd><p>
|
||||
Thrown on failure.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload13.h3"></a>
|
||||
<span><a name="asio.reference.read_until.overload13.remarks"></a></span><a class="link" href="overload13.html#asio.reference.read_until.overload13.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the streambuf may contain additional
|
||||
data beyond that which matched the regular expression. An application will
|
||||
typically leave that data in the streambuf for a subsequent read_until
|
||||
operation to examine.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload13.h4"></a>
|
||||
<span><a name="asio.reference.read_until.overload13.example"></a></span><a class="link" href="overload13.html#asio.reference.read_until.overload13.example">Example</a>
|
||||
</h6>
|
||||
<p>
|
||||
To read data into a streambuf until a CR-LF sequence is encountered:
|
||||
</p>
|
||||
<pre class="programlisting">asio::streambuf b;
|
||||
asio::read_until(s, b, boost::regex("\r\n"));
|
||||
std::istream is(&b);
|
||||
std::string line;
|
||||
std::getline(is, line);
|
||||
</pre>
|
||||
<p>
|
||||
After the <code class="computeroutput">read_until</code> operation completes successfully, the
|
||||
buffer <code class="computeroutput">b</code> contains the data which matched the regular expression:
|
||||
</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">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-2020 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="overload12.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload14.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,114 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (14 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload13.html" title="read_until (13 of 24 overloads)">
|
||||
<link rel="next" href="overload15.html" title="read_until (15 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload13.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload15.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload14"></a><a class="link" href="overload14.html" title="read_until (14 of 24 overloads)">read_until (14
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a streambuf until some part of the data it contains matches
|
||||
a regular expression.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename Allocator>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
asio::basic_streambuf< Allocator > & b,
|
||||
const boost::regex & expr,
|
||||
asio::error_code & ec);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified streambuf until the
|
||||
streambuf's get area contains some data that matches a regular expression.
|
||||
The call will block until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
A substring of the streambuf's get area matches the regular expression.
|
||||
</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
|
||||
read_some function. If the streambuf's get area already contains data that
|
||||
matches the regular expression, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload14.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload14.parameters"></a></span><a class="link" href="overload14.html#asio.reference.read_until.overload14.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">b</span></dt>
|
||||
<dd><p>
|
||||
A streambuf object into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">expr</span></dt>
|
||||
<dd><p>
|
||||
The regular expression.
|
||||
</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="asio.reference.read_until.overload14.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload14.return_value"></a></span><a class="link" href="overload14.html#asio.reference.read_until.overload14.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the streambuf's get area up to and including the
|
||||
substring that matches the regular expression. Returns 0 if an error occurred.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload14.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload14.remarks"></a></span><a class="link" href="overload14.html#asio.reference.read_until.overload14.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the streambuf may contain additional
|
||||
data beyond that which matched the regular expression. An application will
|
||||
typically leave that data in the streambuf for a subsequent read_until
|
||||
operation to examine.
|
||||
</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-2020 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="overload13.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload15.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,205 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (15 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload14.html" title="read_until (14 of 24 overloads)">
|
||||
<link rel="next" href="overload16.html" title="read_until (16 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload14.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload16.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload15"></a><a class="link" href="overload15.html" title="read_until (15 of 24 overloads)">read_until (15
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a streambuf until a function object indicates a match.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename Allocator,
|
||||
typename MatchCondition>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
asio::basic_streambuf< Allocator > & b,
|
||||
MatchCondition match_condition,
|
||||
typename enable_if< is_match_condition< MatchCondition >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified streambuf until a
|
||||
user-defined match condition function object, when applied to the data
|
||||
contained in the streambuf, indicates a successful match. The call will
|
||||
block until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
The match condition function object returns a std::pair where the second
|
||||
element evaluates to true.
|
||||
</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
|
||||
read_some function. If the match condition function object already indicates
|
||||
a match, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload15.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload15.parameters"></a></span><a class="link" href="overload15.html#asio.reference.read_until.overload15.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">b</span></dt>
|
||||
<dd><p>
|
||||
A streambuf object into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">match_condition</span></dt>
|
||||
<dd>
|
||||
<p>
|
||||
The function object to be called to determine whether a match exists.
|
||||
The signature of the function object must be:
|
||||
</p>
|
||||
<pre class="programlisting">pair<iterator, bool> match_condition(iterator begin, iterator end);
|
||||
</pre>
|
||||
<p>
|
||||
where <code class="computeroutput">iterator</code> represents the type:
|
||||
</p>
|
||||
<pre class="programlisting">buffers_iterator<basic_streambuf<Allocator>::const_buffers_type>
|
||||
</pre>
|
||||
<p>
|
||||
The iterator parameters <code class="computeroutput">begin</code> and <code class="computeroutput">end</code> define
|
||||
the range of bytes to be scanned to determine whether there is a
|
||||
match. The <code class="computeroutput">first</code> member of the return value is an iterator
|
||||
marking one-past-the-end of the bytes that have been consumed by
|
||||
the match function. This iterator is used to calculate the <code class="computeroutput">begin</code>
|
||||
parameter for any subsequent invocation of the match condition. The
|
||||
<code class="computeroutput">second</code> member of the return value is true if a match
|
||||
has been found, false otherwise.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload15.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload15.return_value"></a></span><a class="link" href="overload15.html#asio.reference.read_until.overload15.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the streambuf's get area that have been fully consumed
|
||||
by the match function.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload15.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload15.exceptions"></a></span><a class="link" href="overload15.html#asio.reference.read_until.overload15.exceptions">Exceptions</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">asio::system_error</span></dt>
|
||||
<dd><p>
|
||||
Thrown on failure.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload15.h3"></a>
|
||||
<span><a name="asio.reference.read_until.overload15.remarks"></a></span><a class="link" href="overload15.html#asio.reference.read_until.overload15.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the streambuf may contain additional
|
||||
data beyond that which matched the function object. An application will
|
||||
typically leave that data in the streambuf for a subsequent read_until
|
||||
operation to examine.
|
||||
</p>
|
||||
<p>
|
||||
The default implementation of the <code class="computeroutput">is_match_condition</code> type
|
||||
trait evaluates to true for function pointers and function objects with
|
||||
a <code class="computeroutput">result_type</code> typedef. It must be specialised for other user-defined
|
||||
function objects.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload15.h4"></a>
|
||||
<span><a name="asio.reference.read_until.overload15.examples"></a></span><a class="link" href="overload15.html#asio.reference.read_until.overload15.examples">Examples</a>
|
||||
</h6>
|
||||
<p>
|
||||
To read data into a streambuf until whitespace is encountered:
|
||||
</p>
|
||||
<pre class="programlisting">typedef asio::buffers_iterator<
|
||||
asio::streambuf::const_buffers_type> iterator;
|
||||
|
||||
std::pair<iterator, bool>
|
||||
match_whitespace(iterator begin, iterator end)
|
||||
{
|
||||
iterator i = begin;
|
||||
while (i != end)
|
||||
if (std::isspace(*i++))
|
||||
return std::make_pair(i, true);
|
||||
return std::make_pair(i, false);
|
||||
}
|
||||
...
|
||||
asio::streambuf b;
|
||||
asio::read_until(s, b, match_whitespace);
|
||||
</pre>
|
||||
<p>
|
||||
To read data into a streambuf until a matching character is found:
|
||||
</p>
|
||||
<pre class="programlisting">class match_char
|
||||
{
|
||||
public:
|
||||
explicit match_char(char c) : c_(c) {}
|
||||
|
||||
template <typename Iterator>
|
||||
std::pair<Iterator, bool> operator()(
|
||||
Iterator begin, Iterator end) const
|
||||
{
|
||||
Iterator i = begin;
|
||||
while (i != end)
|
||||
if (c_ == *i++)
|
||||
return std::make_pair(i, true);
|
||||
return std::make_pair(i, false);
|
||||
}
|
||||
|
||||
private:
|
||||
char c_;
|
||||
};
|
||||
|
||||
namespace asio {
|
||||
template <> struct is_match_condition<match_char>
|
||||
: public boost::true_type {};
|
||||
} // namespace asio
|
||||
...
|
||||
asio::streambuf b;
|
||||
asio::read_until(s, b, match_char('a'));
|
||||
</pre>
|
||||
</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-2020 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="overload14.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload16.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,143 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (16 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload15.html" title="read_until (15 of 24 overloads)">
|
||||
<link rel="next" href="overload17.html" title="read_until (17 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload15.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload17.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload16"></a><a class="link" href="overload16.html" title="read_until (16 of 24 overloads)">read_until (16
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a streambuf until a function object indicates a match.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename Allocator,
|
||||
typename MatchCondition>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
asio::basic_streambuf< Allocator > & b,
|
||||
MatchCondition match_condition,
|
||||
asio::error_code & ec,
|
||||
typename enable_if< is_match_condition< MatchCondition >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified streambuf until a
|
||||
user-defined match condition function object, when applied to the data
|
||||
contained in the streambuf, indicates a successful match. The call will
|
||||
block until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
The match condition function object returns a std::pair where the second
|
||||
element evaluates to true.
|
||||
</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
|
||||
read_some function. If the match condition function object already indicates
|
||||
a match, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload16.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload16.parameters"></a></span><a class="link" href="overload16.html#asio.reference.read_until.overload16.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">b</span></dt>
|
||||
<dd><p>
|
||||
A streambuf object into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">match_condition</span></dt>
|
||||
<dd>
|
||||
<p>
|
||||
The function object to be called to determine whether a match exists.
|
||||
The signature of the function object must be:
|
||||
</p>
|
||||
<pre class="programlisting">pair<iterator, bool> match_condition(iterator begin, iterator end);
|
||||
</pre>
|
||||
<p>
|
||||
where <code class="computeroutput">iterator</code> represents the type:
|
||||
</p>
|
||||
<pre class="programlisting">buffers_iterator<basic_streambuf<Allocator>::const_buffers_type>
|
||||
</pre>
|
||||
<p>
|
||||
The iterator parameters <code class="computeroutput">begin</code> and <code class="computeroutput">end</code> define
|
||||
the range of bytes to be scanned to determine whether there is a
|
||||
match. The <code class="computeroutput">first</code> member of the return value is an iterator
|
||||
marking one-past-the-end of the bytes that have been consumed by
|
||||
the match function. This iterator is used to calculate the <code class="computeroutput">begin</code>
|
||||
parameter for any subsequent invocation of the match condition. The
|
||||
<code class="computeroutput">second</code> member of the return value is true if a match
|
||||
has been found, false otherwise.
|
||||
</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="asio.reference.read_until.overload16.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload16.return_value"></a></span><a class="link" href="overload16.html#asio.reference.read_until.overload16.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the streambuf's get area that have been fully consumed
|
||||
by the match function. Returns 0 if an error occurred.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload16.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload16.remarks"></a></span><a class="link" href="overload16.html#asio.reference.read_until.overload16.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the streambuf may contain additional
|
||||
data beyond that which matched the function object. An application will
|
||||
typically leave that data in the streambuf for a subsequent read_until
|
||||
operation to examine.
|
||||
</p>
|
||||
<p>
|
||||
The default implementation of the <code class="computeroutput">is_match_condition</code> type
|
||||
trait evaluates to true for function pointers and function objects with
|
||||
a <code class="computeroutput">result_type</code> typedef. It must be specialised for other user-defined
|
||||
function objects.
|
||||
</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-2020 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="overload15.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload17.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,159 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (17 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload16.html" title="read_until (16 of 24 overloads)">
|
||||
<link rel="next" href="overload18.html" title="read_until (18 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload16.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload18.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload17"></a><a class="link" href="overload17.html" title="read_until (17 of 24 overloads)">read_until (17
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a dynamic buffer sequence until it contains a specified
|
||||
delimiter.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename <a class="link" href="../DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
DynamicBuffer_v2 buffers,
|
||||
char delim,
|
||||
typename enable_if< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified dynamic buffer sequence
|
||||
until the dynamic buffer sequence's get area contains the specified delimiter.
|
||||
The call will block until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
The get area of the dynamic buffer sequence 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
|
||||
read_some function. If the dynamic buffer sequence's get area already contains
|
||||
the delimiter, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload17.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload17.parameters"></a></span><a class="link" href="overload17.html#asio.reference.read_until.overload17.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">buffers</span></dt>
|
||||
<dd><p>
|
||||
The dynamic buffer sequence into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">delim</span></dt>
|
||||
<dd><p>
|
||||
The delimiter character.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload17.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload17.return_value"></a></span><a class="link" href="overload17.html#asio.reference.read_until.overload17.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the dynamic buffer sequence's get area up to and
|
||||
including the delimiter.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload17.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload17.exceptions"></a></span><a class="link" href="overload17.html#asio.reference.read_until.overload17.exceptions">Exceptions</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">asio::system_error</span></dt>
|
||||
<dd><p>
|
||||
Thrown on failure.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload17.h3"></a>
|
||||
<span><a name="asio.reference.read_until.overload17.remarks"></a></span><a class="link" href="overload17.html#asio.reference.read_until.overload17.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the dynamic buffer sequence may
|
||||
contain additional data beyond the delimiter. An application will typically
|
||||
leave that data in the dynamic buffer sequence for a subsequent read_until
|
||||
operation to examine.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload17.h4"></a>
|
||||
<span><a name="asio.reference.read_until.overload17.example"></a></span><a class="link" href="overload17.html#asio.reference.read_until.overload17.example">Example</a>
|
||||
</h6>
|
||||
<p>
|
||||
To read data into a <code class="computeroutput">std::string</code> until a newline is encountered:
|
||||
</p>
|
||||
<pre class="programlisting">std::string data;
|
||||
std::size_t n = asio::read_until(s,
|
||||
asio::dynamic_buffer(data), '\n');
|
||||
std::string line = data.substr(0, n);
|
||||
data.erase(0, n);
|
||||
</pre>
|
||||
<p>
|
||||
After the <code class="computeroutput">read_until</code> operation completes successfully, the
|
||||
string <code class="computeroutput">data</code> contains the delimiter:
|
||||
</p>
|
||||
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\n', 'd', 'e', ... }
|
||||
</pre>
|
||||
<p>
|
||||
The call to <code class="computeroutput">substr</code> then extracts the data up to and including
|
||||
the delimiter, so that the string <code class="computeroutput">line</code> contains:
|
||||
</p>
|
||||
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\n' }
|
||||
</pre>
|
||||
<p>
|
||||
After the call to <code class="computeroutput">erase</code>, 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">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-2020 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="overload16.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload18.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,116 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (18 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload17.html" title="read_until (17 of 24 overloads)">
|
||||
<link rel="next" href="overload19.html" title="read_until (19 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload17.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload19.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload18"></a><a class="link" href="overload18.html" title="read_until (18 of 24 overloads)">read_until (18
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a dynamic buffer sequence until it contains a specified
|
||||
delimiter.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename <a class="link" href="../DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
DynamicBuffer_v2 buffers,
|
||||
char delim,
|
||||
asio::error_code & ec,
|
||||
typename enable_if< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified dynamic buffer sequence
|
||||
until the dynamic buffer sequence's get area contains the specified delimiter.
|
||||
The call will block until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
The get area of the dynamic buffer sequence 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
|
||||
read_some function. If the dynamic buffer sequence's get area already contains
|
||||
the delimiter, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload18.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload18.parameters"></a></span><a class="link" href="overload18.html#asio.reference.read_until.overload18.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">buffers</span></dt>
|
||||
<dd><p>
|
||||
The dynamic buffer sequence into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">delim</span></dt>
|
||||
<dd><p>
|
||||
The delimiter character.
|
||||
</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="asio.reference.read_until.overload18.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload18.return_value"></a></span><a class="link" href="overload18.html#asio.reference.read_until.overload18.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the dynamic buffer sequence's get area up to and
|
||||
including the delimiter. Returns 0 if an error occurred.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload18.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload18.remarks"></a></span><a class="link" href="overload18.html#asio.reference.read_until.overload18.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the dynamic buffer sequence may
|
||||
contain additional data beyond the delimiter. An application will typically
|
||||
leave that data in the dynamic buffer sequence for a subsequent read_until
|
||||
operation to examine.
|
||||
</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-2020 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="overload17.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload19.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,147 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (19 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload18.html" title="read_until (18 of 24 overloads)">
|
||||
<link rel="next" href="overload20.html" title="read_until (20 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload18.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload20.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload19"></a><a class="link" href="overload19.html" title="read_until (19 of 24 overloads)">read_until (19
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a dynamic buffer sequence until it contains a specified
|
||||
delimiter.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename <a class="link" href="../DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
DynamicBuffer_v2 buffers,
|
||||
string_view delim,
|
||||
typename enable_if< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified dynamic buffer sequence
|
||||
until the dynamic buffer sequence's get area contains the specified delimiter.
|
||||
The call will block until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
The get area of the dynamic buffer sequence 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
|
||||
read_some function. If the dynamic buffer sequence's get area already contains
|
||||
the delimiter, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload19.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload19.parameters"></a></span><a class="link" href="overload19.html#asio.reference.read_until.overload19.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">buffers</span></dt>
|
||||
<dd><p>
|
||||
The dynamic buffer sequence into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">delim</span></dt>
|
||||
<dd><p>
|
||||
The delimiter string.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload19.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload19.return_value"></a></span><a class="link" href="overload19.html#asio.reference.read_until.overload19.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the dynamic buffer sequence's get area up to and
|
||||
including the delimiter.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload19.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload19.remarks"></a></span><a class="link" href="overload19.html#asio.reference.read_until.overload19.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the dynamic buffer sequence may
|
||||
contain additional data beyond the delimiter. An application will typically
|
||||
leave that data in the dynamic buffer sequence for a subsequent read_until
|
||||
operation to examine.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload19.h3"></a>
|
||||
<span><a name="asio.reference.read_until.overload19.example"></a></span><a class="link" href="overload19.html#asio.reference.read_until.overload19.example">Example</a>
|
||||
</h6>
|
||||
<p>
|
||||
To read data into a <code class="computeroutput">std::string</code> until a CR-LF sequence is
|
||||
encountered:
|
||||
</p>
|
||||
<pre class="programlisting">std::string data;
|
||||
std::size_t n = asio::read_until(s,
|
||||
asio::dynamic_buffer(data), "\r\n");
|
||||
std::string line = data.substr(0, n);
|
||||
data.erase(0, n);
|
||||
</pre>
|
||||
<p>
|
||||
After the <code class="computeroutput">read_until</code> operation completes successfully, the
|
||||
string <code class="computeroutput">data</code> contains the delimiter:
|
||||
</p>
|
||||
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
|
||||
</pre>
|
||||
<p>
|
||||
The call to <code class="computeroutput">substr</code> then extracts the data up to and including
|
||||
the delimiter, so that the string <code class="computeroutput">line</code> contains:
|
||||
</p>
|
||||
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\r', '\n' }
|
||||
</pre>
|
||||
<p>
|
||||
After the call to <code class="computeroutput">erase</code>, 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">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-2020 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="overload18.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload20.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,116 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (2 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload1.html" title="read_until (1 of 24 overloads)">
|
||||
<link rel="next" href="overload3.html" title="read_until (3 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload1.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload2"></a><a class="link" href="overload2.html" title="read_until (2 of 24 overloads)">read_until (2
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a dynamic buffer sequence until it contains a specified
|
||||
delimiter.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename <a class="link" href="../DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
DynamicBuffer_v1 && buffers,
|
||||
char delim,
|
||||
asio::error_code & ec,
|
||||
typename enable_if< is_dynamic_buffer_v1< typename decay< DynamicBuffer_v1 >::type >::value &&!is_dynamic_buffer_v2< typename decay< DynamicBuffer_v1 >::type >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified dynamic buffer sequence
|
||||
until the dynamic buffer sequence's get area contains the specified delimiter.
|
||||
The call will block until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
The get area of the dynamic buffer sequence 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
|
||||
read_some function. If the dynamic buffer sequence's get area already contains
|
||||
the delimiter, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload2.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.read_until.overload2.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">buffers</span></dt>
|
||||
<dd><p>
|
||||
The dynamic buffer sequence into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">delim</span></dt>
|
||||
<dd><p>
|
||||
The delimiter character.
|
||||
</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="asio.reference.read_until.overload2.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload2.return_value"></a></span><a class="link" href="overload2.html#asio.reference.read_until.overload2.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the dynamic buffer sequence's get area up to and
|
||||
including the delimiter. Returns 0 if an error occurred.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload2.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.read_until.overload2.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the dynamic buffer sequence may
|
||||
contain additional data beyond the delimiter. An application will typically
|
||||
leave that data in the dynamic buffer sequence for a subsequent read_until
|
||||
operation to examine.
|
||||
</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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,116 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (20 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload19.html" title="read_until (19 of 24 overloads)">
|
||||
<link rel="next" href="overload21.html" title="read_until (21 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload19.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload21.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload20"></a><a class="link" href="overload20.html" title="read_until (20 of 24 overloads)">read_until (20
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a dynamic buffer sequence until it contains a specified
|
||||
delimiter.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename <a class="link" href="../DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
DynamicBuffer_v2 buffers,
|
||||
string_view delim,
|
||||
asio::error_code & ec,
|
||||
typename enable_if< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified dynamic buffer sequence
|
||||
until the dynamic buffer sequence's get area contains the specified delimiter.
|
||||
The call will block until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
The get area of the dynamic buffer sequence 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
|
||||
read_some function. If the dynamic buffer sequence's get area already contains
|
||||
the delimiter, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload20.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload20.parameters"></a></span><a class="link" href="overload20.html#asio.reference.read_until.overload20.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">buffers</span></dt>
|
||||
<dd><p>
|
||||
The dynamic buffer sequence into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">delim</span></dt>
|
||||
<dd><p>
|
||||
The delimiter string.
|
||||
</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="asio.reference.read_until.overload20.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload20.return_value"></a></span><a class="link" href="overload20.html#asio.reference.read_until.overload20.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the dynamic buffer sequence's get area up to and
|
||||
including the delimiter. Returns 0 if an error occurred.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload20.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload20.remarks"></a></span><a class="link" href="overload20.html#asio.reference.read_until.overload20.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the dynamic buffer sequence may
|
||||
contain additional data beyond the delimiter. An application will typically
|
||||
leave that data in the dynamic buffer sequence for a subsequent read_until
|
||||
operation to examine.
|
||||
</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-2020 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="overload19.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload21.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,161 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (21 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload20.html" title="read_until (20 of 24 overloads)">
|
||||
<link rel="next" href="overload22.html" title="read_until (22 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload20.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload22.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload21"></a><a class="link" href="overload21.html" title="read_until (21 of 24 overloads)">read_until (21
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a dynamic buffer sequence until some part of the data it
|
||||
contains matches a regular expression.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename <a class="link" href="../DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
DynamicBuffer_v2 buffers,
|
||||
const boost::regex & expr,
|
||||
typename enable_if< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified dynamic buffer sequence
|
||||
until the dynamic buffer sequence's get area contains some data that matches
|
||||
a regular expression. The call will block until one of the following conditions
|
||||
is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
A substring of the dynamic buffer sequence's get area matches the regular
|
||||
expression.
|
||||
</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
|
||||
read_some function. If the dynamic buffer sequence's get area already contains
|
||||
data that matches the regular expression, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload21.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload21.parameters"></a></span><a class="link" href="overload21.html#asio.reference.read_until.overload21.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">buffers</span></dt>
|
||||
<dd><p>
|
||||
A dynamic buffer sequence into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">expr</span></dt>
|
||||
<dd><p>
|
||||
The regular expression.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload21.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload21.return_value"></a></span><a class="link" href="overload21.html#asio.reference.read_until.overload21.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the dynamic buffer sequence's get area up to and
|
||||
including the substring that matches the regular expression.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload21.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload21.exceptions"></a></span><a class="link" href="overload21.html#asio.reference.read_until.overload21.exceptions">Exceptions</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">asio::system_error</span></dt>
|
||||
<dd><p>
|
||||
Thrown on failure.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload21.h3"></a>
|
||||
<span><a name="asio.reference.read_until.overload21.remarks"></a></span><a class="link" href="overload21.html#asio.reference.read_until.overload21.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the dynamic buffer sequence may
|
||||
contain additional data beyond that which matched the regular expression.
|
||||
An application will typically leave that data in the dynamic buffer sequence
|
||||
for a subsequent read_until operation to examine.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload21.h4"></a>
|
||||
<span><a name="asio.reference.read_until.overload21.example"></a></span><a class="link" href="overload21.html#asio.reference.read_until.overload21.example">Example</a>
|
||||
</h6>
|
||||
<p>
|
||||
To read data into a <code class="computeroutput">std::string</code> until a CR-LF sequence is
|
||||
encountered:
|
||||
</p>
|
||||
<pre class="programlisting">std::string data;
|
||||
std::size_t n = asio::read_until(s,
|
||||
asio::dynamic_buffer(data), boost::regex("\r\n"));
|
||||
std::string line = data.substr(0, n);
|
||||
data.erase(0, n);
|
||||
</pre>
|
||||
<p>
|
||||
After the <code class="computeroutput">read_until</code> operation completes successfully, the
|
||||
string <code class="computeroutput">data</code> contains the delimiter:
|
||||
</p>
|
||||
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
|
||||
</pre>
|
||||
<p>
|
||||
The call to <code class="computeroutput">substr</code> then extracts the data up to and including
|
||||
the delimiter, so that the string <code class="computeroutput">line</code> contains:
|
||||
</p>
|
||||
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\r', '\n' }
|
||||
</pre>
|
||||
<p>
|
||||
After the call to <code class="computeroutput">erase</code>, 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">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-2020 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="overload20.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload22.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,118 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (22 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload21.html" title="read_until (21 of 24 overloads)">
|
||||
<link rel="next" href="overload23.html" title="read_until (23 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload21.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload23.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload22"></a><a class="link" href="overload22.html" title="read_until (22 of 24 overloads)">read_until (22
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a dynamic buffer sequence until some part of the data it
|
||||
contains matches a regular expression.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename <a class="link" href="../DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
DynamicBuffer_v2 buffers,
|
||||
const boost::regex & expr,
|
||||
asio::error_code & ec,
|
||||
typename enable_if< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified dynamic buffer sequence
|
||||
until the dynamic buffer sequence's get area contains some data that matches
|
||||
a regular expression. The call will block until one of the following conditions
|
||||
is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
A substring of the dynamic buffer sequence's get area matches the regular
|
||||
expression.
|
||||
</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
|
||||
read_some function. If the dynamic buffer sequence's get area already contains
|
||||
data that matches the regular expression, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload22.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload22.parameters"></a></span><a class="link" href="overload22.html#asio.reference.read_until.overload22.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">buffers</span></dt>
|
||||
<dd><p>
|
||||
A dynamic buffer sequence into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">expr</span></dt>
|
||||
<dd><p>
|
||||
The regular expression.
|
||||
</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="asio.reference.read_until.overload22.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload22.return_value"></a></span><a class="link" href="overload22.html#asio.reference.read_until.overload22.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the dynamic buffer sequence's get area up to and
|
||||
including the substring that matches the regular expression. Returns 0
|
||||
if an error occurred.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload22.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload22.remarks"></a></span><a class="link" href="overload22.html#asio.reference.read_until.overload22.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the dynamic buffer sequence may
|
||||
contain additional data beyond that which matched the regular expression.
|
||||
An application will typically leave that data in the dynamic buffer sequence
|
||||
for a subsequent read_until operation to examine.
|
||||
</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-2020 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="overload21.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload23.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,207 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (23 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload22.html" title="read_until (22 of 24 overloads)">
|
||||
<link rel="next" href="overload24.html" title="read_until (24 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload22.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload24.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload23"></a><a class="link" href="overload23.html" title="read_until (23 of 24 overloads)">read_until (23
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a dynamic buffer sequence until a function object indicates
|
||||
a match.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename <a class="link" href="../DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>,
|
||||
typename MatchCondition>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
DynamicBuffer_v2 buffers,
|
||||
MatchCondition match_condition,
|
||||
typename enable_if< is_match_condition< MatchCondition >::value &&is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified dynamic buffer sequence
|
||||
until a user-defined match condition function object, when applied to the
|
||||
data contained in the dynamic buffer sequence, indicates a successful match.
|
||||
The call will block until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
The match condition function object returns a std::pair where the second
|
||||
element evaluates to true.
|
||||
</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
|
||||
read_some function. If the match condition function object already indicates
|
||||
a match, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload23.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload23.parameters"></a></span><a class="link" href="overload23.html#asio.reference.read_until.overload23.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">buffers</span></dt>
|
||||
<dd><p>
|
||||
A dynamic buffer sequence into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">match_condition</span></dt>
|
||||
<dd>
|
||||
<p>
|
||||
The function object to be called to determine whether a match exists.
|
||||
The signature of the function object must be:
|
||||
</p>
|
||||
<pre class="programlisting">pair<iterator, bool> match_condition(iterator begin, iterator end);
|
||||
</pre>
|
||||
<p>
|
||||
where <code class="computeroutput">iterator</code> represents the type:
|
||||
</p>
|
||||
<pre class="programlisting">buffers_iterator<typename DynamicBuffer_v2::const_buffers_type>
|
||||
</pre>
|
||||
<p>
|
||||
The iterator parameters <code class="computeroutput">begin</code> and <code class="computeroutput">end</code> define
|
||||
the range of bytes to be scanned to determine whether there is a
|
||||
match. The <code class="computeroutput">first</code> member of the return value is an iterator
|
||||
marking one-past-the-end of the bytes that have been consumed by
|
||||
the match function. This iterator is used to calculate the <code class="computeroutput">begin</code>
|
||||
parameter for any subsequent invocation of the match condition. The
|
||||
<code class="computeroutput">second</code> member of the return value is true if a match
|
||||
has been found, false otherwise.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload23.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload23.return_value"></a></span><a class="link" href="overload23.html#asio.reference.read_until.overload23.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the dynamic_buffer's get area that have been fully
|
||||
consumed by the match function.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload23.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload23.exceptions"></a></span><a class="link" href="overload23.html#asio.reference.read_until.overload23.exceptions">Exceptions</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">asio::system_error</span></dt>
|
||||
<dd><p>
|
||||
Thrown on failure.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload23.h3"></a>
|
||||
<span><a name="asio.reference.read_until.overload23.remarks"></a></span><a class="link" href="overload23.html#asio.reference.read_until.overload23.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the dynamic buffer sequence may
|
||||
contain additional data beyond that which matched the function object.
|
||||
An application will typically leave that data in the dynamic buffer sequence
|
||||
for a subsequent read_until operation to examine.
|
||||
</p>
|
||||
<p>
|
||||
The default implementation of the <code class="computeroutput">is_match_condition</code> type
|
||||
trait evaluates to true for function pointers and function objects with
|
||||
a <code class="computeroutput">result_type</code> typedef. It must be specialised for other user-defined
|
||||
function objects.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload23.h4"></a>
|
||||
<span><a name="asio.reference.read_until.overload23.examples"></a></span><a class="link" href="overload23.html#asio.reference.read_until.overload23.examples">Examples</a>
|
||||
</h6>
|
||||
<p>
|
||||
To read data into a dynamic buffer sequence until whitespace is encountered:
|
||||
</p>
|
||||
<pre class="programlisting">typedef asio::buffers_iterator<
|
||||
asio::const_buffers_1> iterator;
|
||||
|
||||
std::pair<iterator, bool>
|
||||
match_whitespace(iterator begin, iterator end)
|
||||
{
|
||||
iterator i = begin;
|
||||
while (i != end)
|
||||
if (std::isspace(*i++))
|
||||
return std::make_pair(i, true);
|
||||
return std::make_pair(i, false);
|
||||
}
|
||||
...
|
||||
std::string data;
|
||||
asio::read_until(s, data, match_whitespace);
|
||||
</pre>
|
||||
<p>
|
||||
To read data into a <code class="computeroutput">std::string</code> until a matching character
|
||||
is found:
|
||||
</p>
|
||||
<pre class="programlisting">class match_char
|
||||
{
|
||||
public:
|
||||
explicit match_char(char c) : c_(c) {}
|
||||
|
||||
template <typename Iterator>
|
||||
std::pair<Iterator, bool> operator()(
|
||||
Iterator begin, Iterator end) const
|
||||
{
|
||||
Iterator i = begin;
|
||||
while (i != end)
|
||||
if (c_ == *i++)
|
||||
return std::make_pair(i, true);
|
||||
return std::make_pair(i, false);
|
||||
}
|
||||
|
||||
private:
|
||||
char c_;
|
||||
};
|
||||
|
||||
namespace asio {
|
||||
template <> struct is_match_condition<match_char>
|
||||
: public boost::true_type {};
|
||||
} // namespace asio
|
||||
...
|
||||
std::string data;
|
||||
asio::read_until(s, data, match_char('a'));
|
||||
</pre>
|
||||
</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-2020 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="overload22.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload24.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,144 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (24 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload23.html" title="read_until (23 of 24 overloads)">
|
||||
<link rel="next" href="../redirect_error.html" title="redirect_error">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload23.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="../redirect_error.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload24"></a><a class="link" href="overload24.html" title="read_until (24 of 24 overloads)">read_until (24
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a dynamic buffer sequence until a function object indicates
|
||||
a match.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename <a class="link" href="../DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>,
|
||||
typename MatchCondition>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
DynamicBuffer_v2 buffers,
|
||||
MatchCondition match_condition,
|
||||
asio::error_code & ec,
|
||||
typename enable_if< is_match_condition< MatchCondition >::value &&is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified dynamic buffer sequence
|
||||
until a user-defined match condition function object, when applied to the
|
||||
data contained in the dynamic buffer sequence, indicates a successful match.
|
||||
The call will block until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
The match condition function object returns a std::pair where the second
|
||||
element evaluates to true.
|
||||
</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
|
||||
read_some function. If the match condition function object already indicates
|
||||
a match, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload24.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload24.parameters"></a></span><a class="link" href="overload24.html#asio.reference.read_until.overload24.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">buffers</span></dt>
|
||||
<dd><p>
|
||||
A dynamic buffer sequence into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">match_condition</span></dt>
|
||||
<dd>
|
||||
<p>
|
||||
The function object to be called to determine whether a match exists.
|
||||
The signature of the function object must be:
|
||||
</p>
|
||||
<pre class="programlisting">pair<iterator, bool> match_condition(iterator begin, iterator end);
|
||||
</pre>
|
||||
<p>
|
||||
where <code class="computeroutput">iterator</code> represents the type:
|
||||
</p>
|
||||
<pre class="programlisting">buffers_iterator<DynamicBuffer_v2::const_buffers_type>
|
||||
</pre>
|
||||
<p>
|
||||
The iterator parameters <code class="computeroutput">begin</code> and <code class="computeroutput">end</code> define
|
||||
the range of bytes to be scanned to determine whether there is a
|
||||
match. The <code class="computeroutput">first</code> member of the return value is an iterator
|
||||
marking one-past-the-end of the bytes that have been consumed by
|
||||
the match function. This iterator is used to calculate the <code class="computeroutput">begin</code>
|
||||
parameter for any subsequent invocation of the match condition. The
|
||||
<code class="computeroutput">second</code> member of the return value is true if a match
|
||||
has been found, false otherwise.
|
||||
</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="asio.reference.read_until.overload24.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload24.return_value"></a></span><a class="link" href="overload24.html#asio.reference.read_until.overload24.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the dynamic buffer sequence's get area that have
|
||||
been fully consumed by the match function. Returns 0 if an error occurred.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload24.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload24.remarks"></a></span><a class="link" href="overload24.html#asio.reference.read_until.overload24.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the dynamic buffer sequence may
|
||||
contain additional data beyond that which matched the function object.
|
||||
An application will typically leave that data in the dynamic buffer sequence
|
||||
for a subsequent read_until operation to examine.
|
||||
</p>
|
||||
<p>
|
||||
The default implementation of the <code class="computeroutput">is_match_condition</code> type
|
||||
trait evaluates to true for function pointers and function objects with
|
||||
a <code class="computeroutput">result_type</code> typedef. It must be specialised for other user-defined
|
||||
function objects.
|
||||
</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-2020 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="overload23.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="../redirect_error.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,147 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (3 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload2.html" title="read_until (2 of 24 overloads)">
|
||||
<link rel="next" href="overload4.html" title="read_until (4 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload4.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload3"></a><a class="link" href="overload3.html" title="read_until (3 of 24 overloads)">read_until (3
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a dynamic buffer sequence until it contains a specified
|
||||
delimiter.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename <a class="link" href="../DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
DynamicBuffer_v1 && buffers,
|
||||
string_view delim,
|
||||
typename enable_if< is_dynamic_buffer_v1< typename decay< DynamicBuffer_v1 >::type >::value &&!is_dynamic_buffer_v2< typename decay< DynamicBuffer_v1 >::type >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified dynamic buffer sequence
|
||||
until the dynamic buffer sequence's get area contains the specified delimiter.
|
||||
The call will block until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
The get area of the dynamic buffer sequence 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
|
||||
read_some function. If the dynamic buffer sequence's get area already contains
|
||||
the delimiter, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload3.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload3.parameters"></a></span><a class="link" href="overload3.html#asio.reference.read_until.overload3.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">buffers</span></dt>
|
||||
<dd><p>
|
||||
The dynamic buffer sequence into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">delim</span></dt>
|
||||
<dd><p>
|
||||
The delimiter string.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload3.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload3.return_value"></a></span><a class="link" href="overload3.html#asio.reference.read_until.overload3.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the dynamic buffer sequence's get area up to and
|
||||
including the delimiter.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload3.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload3.remarks"></a></span><a class="link" href="overload3.html#asio.reference.read_until.overload3.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the dynamic buffer sequence may
|
||||
contain additional data beyond the delimiter. An application will typically
|
||||
leave that data in the dynamic buffer sequence for a subsequent read_until
|
||||
operation to examine.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload3.h3"></a>
|
||||
<span><a name="asio.reference.read_until.overload3.example"></a></span><a class="link" href="overload3.html#asio.reference.read_until.overload3.example">Example</a>
|
||||
</h6>
|
||||
<p>
|
||||
To read data into a <code class="computeroutput">std::string</code> until a CR-LF sequence is
|
||||
encountered:
|
||||
</p>
|
||||
<pre class="programlisting">std::string data;
|
||||
std::size_t n = asio::read_until(s,
|
||||
asio::dynamic_buffer(data), "\r\n");
|
||||
std::string line = data.substr(0, n);
|
||||
data.erase(0, n);
|
||||
</pre>
|
||||
<p>
|
||||
After the <code class="computeroutput">read_until</code> operation completes successfully, the
|
||||
string <code class="computeroutput">data</code> contains the delimiter:
|
||||
</p>
|
||||
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
|
||||
</pre>
|
||||
<p>
|
||||
The call to <code class="computeroutput">substr</code> then extracts the data up to and including
|
||||
the delimiter, so that the string <code class="computeroutput">line</code> contains:
|
||||
</p>
|
||||
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\r', '\n' }
|
||||
</pre>
|
||||
<p>
|
||||
After the call to <code class="computeroutput">erase</code>, 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">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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload4.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,116 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (4 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload3.html" title="read_until (3 of 24 overloads)">
|
||||
<link rel="next" href="overload5.html" title="read_until (5 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload3.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload5.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload4"></a><a class="link" href="overload4.html" title="read_until (4 of 24 overloads)">read_until (4
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a dynamic buffer sequence until it contains a specified
|
||||
delimiter.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename <a class="link" href="../DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
DynamicBuffer_v1 && buffers,
|
||||
string_view delim,
|
||||
asio::error_code & ec,
|
||||
typename enable_if< is_dynamic_buffer_v1< typename decay< DynamicBuffer_v1 >::type >::value &&!is_dynamic_buffer_v2< typename decay< DynamicBuffer_v1 >::type >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified dynamic buffer sequence
|
||||
until the dynamic buffer sequence's get area contains the specified delimiter.
|
||||
The call will block until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
The get area of the dynamic buffer sequence 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
|
||||
read_some function. If the dynamic buffer sequence's get area already contains
|
||||
the delimiter, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload4.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload4.parameters"></a></span><a class="link" href="overload4.html#asio.reference.read_until.overload4.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">buffers</span></dt>
|
||||
<dd><p>
|
||||
The dynamic buffer sequence into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">delim</span></dt>
|
||||
<dd><p>
|
||||
The delimiter string.
|
||||
</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="asio.reference.read_until.overload4.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload4.return_value"></a></span><a class="link" href="overload4.html#asio.reference.read_until.overload4.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the dynamic buffer sequence's get area up to and
|
||||
including the delimiter. Returns 0 if an error occurred.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload4.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload4.remarks"></a></span><a class="link" href="overload4.html#asio.reference.read_until.overload4.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the dynamic buffer sequence may
|
||||
contain additional data beyond the delimiter. An application will typically
|
||||
leave that data in the dynamic buffer sequence for a subsequent read_until
|
||||
operation to examine.
|
||||
</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-2020 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="overload3.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload5.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,161 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (5 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload4.html" title="read_until (4 of 24 overloads)">
|
||||
<link rel="next" href="overload6.html" title="read_until (6 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload4.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload6.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload5"></a><a class="link" href="overload5.html" title="read_until (5 of 24 overloads)">read_until (5
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a dynamic buffer sequence until some part of the data it
|
||||
contains matches a regular expression.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename <a class="link" href="../DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
DynamicBuffer_v1 && buffers,
|
||||
const boost::regex & expr,
|
||||
typename enable_if< is_dynamic_buffer_v1< typename decay< DynamicBuffer_v1 >::type >::value &&!is_dynamic_buffer_v2< typename decay< DynamicBuffer_v1 >::type >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified dynamic buffer sequence
|
||||
until the dynamic buffer sequence's get area contains some data that matches
|
||||
a regular expression. The call will block until one of the following conditions
|
||||
is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
A substring of the dynamic buffer sequence's get area matches the regular
|
||||
expression.
|
||||
</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
|
||||
read_some function. If the dynamic buffer sequence's get area already contains
|
||||
data that matches the regular expression, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload5.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload5.parameters"></a></span><a class="link" href="overload5.html#asio.reference.read_until.overload5.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">buffers</span></dt>
|
||||
<dd><p>
|
||||
A dynamic buffer sequence into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">expr</span></dt>
|
||||
<dd><p>
|
||||
The regular expression.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload5.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload5.return_value"></a></span><a class="link" href="overload5.html#asio.reference.read_until.overload5.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the dynamic buffer sequence's get area up to and
|
||||
including the substring that matches the regular expression.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload5.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload5.exceptions"></a></span><a class="link" href="overload5.html#asio.reference.read_until.overload5.exceptions">Exceptions</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">asio::system_error</span></dt>
|
||||
<dd><p>
|
||||
Thrown on failure.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload5.h3"></a>
|
||||
<span><a name="asio.reference.read_until.overload5.remarks"></a></span><a class="link" href="overload5.html#asio.reference.read_until.overload5.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the dynamic buffer sequence may
|
||||
contain additional data beyond that which matched the regular expression.
|
||||
An application will typically leave that data in the dynamic buffer sequence
|
||||
for a subsequent read_until operation to examine.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload5.h4"></a>
|
||||
<span><a name="asio.reference.read_until.overload5.example"></a></span><a class="link" href="overload5.html#asio.reference.read_until.overload5.example">Example</a>
|
||||
</h6>
|
||||
<p>
|
||||
To read data into a <code class="computeroutput">std::string</code> until a CR-LF sequence is
|
||||
encountered:
|
||||
</p>
|
||||
<pre class="programlisting">std::string data;
|
||||
std::size_t n = asio::read_until(s,
|
||||
asio::dynamic_buffer(data), boost::regex("\r\n"));
|
||||
std::string line = data.substr(0, n);
|
||||
data.erase(0, n);
|
||||
</pre>
|
||||
<p>
|
||||
After the <code class="computeroutput">read_until</code> operation completes successfully, the
|
||||
string <code class="computeroutput">data</code> contains the delimiter:
|
||||
</p>
|
||||
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
|
||||
</pre>
|
||||
<p>
|
||||
The call to <code class="computeroutput">substr</code> then extracts the data up to and including
|
||||
the delimiter, so that the string <code class="computeroutput">line</code> contains:
|
||||
</p>
|
||||
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\r', '\n' }
|
||||
</pre>
|
||||
<p>
|
||||
After the call to <code class="computeroutput">erase</code>, 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">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-2020 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="overload4.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload6.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,118 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (6 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload5.html" title="read_until (5 of 24 overloads)">
|
||||
<link rel="next" href="overload7.html" title="read_until (7 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload5.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload7.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload6"></a><a class="link" href="overload6.html" title="read_until (6 of 24 overloads)">read_until (6
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a dynamic buffer sequence until some part of the data it
|
||||
contains matches a regular expression.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename <a class="link" href="../DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
DynamicBuffer_v1 && buffers,
|
||||
const boost::regex & expr,
|
||||
asio::error_code & ec,
|
||||
typename enable_if< is_dynamic_buffer_v1< typename decay< DynamicBuffer_v1 >::type >::value &&!is_dynamic_buffer_v2< typename decay< DynamicBuffer_v1 >::type >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified dynamic buffer sequence
|
||||
until the dynamic buffer sequence's get area contains some data that matches
|
||||
a regular expression. The call will block until one of the following conditions
|
||||
is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
A substring of the dynamic buffer sequence's get area matches the regular
|
||||
expression.
|
||||
</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
|
||||
read_some function. If the dynamic buffer sequence's get area already contains
|
||||
data that matches the regular expression, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload6.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload6.parameters"></a></span><a class="link" href="overload6.html#asio.reference.read_until.overload6.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">buffers</span></dt>
|
||||
<dd><p>
|
||||
A dynamic buffer sequence into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">expr</span></dt>
|
||||
<dd><p>
|
||||
The regular expression.
|
||||
</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="asio.reference.read_until.overload6.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload6.return_value"></a></span><a class="link" href="overload6.html#asio.reference.read_until.overload6.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the dynamic buffer sequence's get area up to and
|
||||
including the substring that matches the regular expression. Returns 0
|
||||
if an error occurred.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload6.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload6.remarks"></a></span><a class="link" href="overload6.html#asio.reference.read_until.overload6.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the dynamic buffer sequence may
|
||||
contain additional data beyond that which matched the regular expression.
|
||||
An application will typically leave that data in the dynamic buffer sequence
|
||||
for a subsequent read_until operation to examine.
|
||||
</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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload7.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,207 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (7 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload6.html" title="read_until (6 of 24 overloads)">
|
||||
<link rel="next" href="overload8.html" title="read_until (8 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload6.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload8.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload7"></a><a class="link" href="overload7.html" title="read_until (7 of 24 overloads)">read_until (7
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a dynamic buffer sequence until a function object indicates
|
||||
a match.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename <a class="link" href="../DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>,
|
||||
typename MatchCondition>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
DynamicBuffer_v1 && buffers,
|
||||
MatchCondition match_condition,
|
||||
typename enable_if< is_match_condition< MatchCondition >::value &&is_dynamic_buffer_v1< typename decay< DynamicBuffer_v1 >::type >::value &&!is_dynamic_buffer_v2< typename decay< DynamicBuffer_v1 >::type >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified dynamic buffer sequence
|
||||
until a user-defined match condition function object, when applied to the
|
||||
data contained in the dynamic buffer sequence, indicates a successful match.
|
||||
The call will block until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
The match condition function object returns a std::pair where the second
|
||||
element evaluates to true.
|
||||
</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
|
||||
read_some function. If the match condition function object already indicates
|
||||
a match, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload7.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload7.parameters"></a></span><a class="link" href="overload7.html#asio.reference.read_until.overload7.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">buffers</span></dt>
|
||||
<dd><p>
|
||||
A dynamic buffer sequence into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">match_condition</span></dt>
|
||||
<dd>
|
||||
<p>
|
||||
The function object to be called to determine whether a match exists.
|
||||
The signature of the function object must be:
|
||||
</p>
|
||||
<pre class="programlisting">pair<iterator, bool> match_condition(iterator begin, iterator end);
|
||||
</pre>
|
||||
<p>
|
||||
where <code class="computeroutput">iterator</code> represents the type:
|
||||
</p>
|
||||
<pre class="programlisting">buffers_iterator<typename DynamicBuffer_v1::const_buffers_type>
|
||||
</pre>
|
||||
<p>
|
||||
The iterator parameters <code class="computeroutput">begin</code> and <code class="computeroutput">end</code> define
|
||||
the range of bytes to be scanned to determine whether there is a
|
||||
match. The <code class="computeroutput">first</code> member of the return value is an iterator
|
||||
marking one-past-the-end of the bytes that have been consumed by
|
||||
the match function. This iterator is used to calculate the <code class="computeroutput">begin</code>
|
||||
parameter for any subsequent invocation of the match condition. The
|
||||
<code class="computeroutput">second</code> member of the return value is true if a match
|
||||
has been found, false otherwise.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload7.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload7.return_value"></a></span><a class="link" href="overload7.html#asio.reference.read_until.overload7.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the dynamic_buffer's get area that have been fully
|
||||
consumed by the match function.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload7.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload7.exceptions"></a></span><a class="link" href="overload7.html#asio.reference.read_until.overload7.exceptions">Exceptions</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">asio::system_error</span></dt>
|
||||
<dd><p>
|
||||
Thrown on failure.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload7.h3"></a>
|
||||
<span><a name="asio.reference.read_until.overload7.remarks"></a></span><a class="link" href="overload7.html#asio.reference.read_until.overload7.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the dynamic buffer sequence may
|
||||
contain additional data beyond that which matched the function object.
|
||||
An application will typically leave that data in the dynamic buffer sequence
|
||||
for a subsequent read_until operation to examine.
|
||||
</p>
|
||||
<p>
|
||||
The default implementation of the <code class="computeroutput">is_match_condition</code> type
|
||||
trait evaluates to true for function pointers and function objects with
|
||||
a <code class="computeroutput">result_type</code> typedef. It must be specialised for other user-defined
|
||||
function objects.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload7.h4"></a>
|
||||
<span><a name="asio.reference.read_until.overload7.examples"></a></span><a class="link" href="overload7.html#asio.reference.read_until.overload7.examples">Examples</a>
|
||||
</h6>
|
||||
<p>
|
||||
To read data into a dynamic buffer sequence until whitespace is encountered:
|
||||
</p>
|
||||
<pre class="programlisting">typedef asio::buffers_iterator<
|
||||
asio::const_buffers_1> iterator;
|
||||
|
||||
std::pair<iterator, bool>
|
||||
match_whitespace(iterator begin, iterator end)
|
||||
{
|
||||
iterator i = begin;
|
||||
while (i != end)
|
||||
if (std::isspace(*i++))
|
||||
return std::make_pair(i, true);
|
||||
return std::make_pair(i, false);
|
||||
}
|
||||
...
|
||||
std::string data;
|
||||
asio::read_until(s, data, match_whitespace);
|
||||
</pre>
|
||||
<p>
|
||||
To read data into a <code class="computeroutput">std::string</code> until a matching character
|
||||
is found:
|
||||
</p>
|
||||
<pre class="programlisting">class match_char
|
||||
{
|
||||
public:
|
||||
explicit match_char(char c) : c_(c) {}
|
||||
|
||||
template <typename Iterator>
|
||||
std::pair<Iterator, bool> operator()(
|
||||
Iterator begin, Iterator end) const
|
||||
{
|
||||
Iterator i = begin;
|
||||
while (i != end)
|
||||
if (c_ == *i++)
|
||||
return std::make_pair(i, true);
|
||||
return std::make_pair(i, false);
|
||||
}
|
||||
|
||||
private:
|
||||
char c_;
|
||||
};
|
||||
|
||||
namespace asio {
|
||||
template <> struct is_match_condition<match_char>
|
||||
: public boost::true_type {};
|
||||
} // namespace asio
|
||||
...
|
||||
std::string data;
|
||||
asio::read_until(s, data, match_char('a'));
|
||||
</pre>
|
||||
</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-2020 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="overload6.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload8.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,144 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (8 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload7.html" title="read_until (7 of 24 overloads)">
|
||||
<link rel="next" href="overload9.html" title="read_until (9 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload7.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload9.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload8"></a><a class="link" href="overload8.html" title="read_until (8 of 24 overloads)">read_until (8
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a dynamic buffer sequence until a function object indicates
|
||||
a match.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename <a class="link" href="../DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>,
|
||||
typename MatchCondition>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
DynamicBuffer_v1 && buffers,
|
||||
MatchCondition match_condition,
|
||||
asio::error_code & ec,
|
||||
typename enable_if< is_match_condition< MatchCondition >::value &&is_dynamic_buffer_v1< typename decay< DynamicBuffer_v1 >::type >::value &&!is_dynamic_buffer_v2< typename decay< DynamicBuffer_v1 >::type >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified dynamic buffer sequence
|
||||
until a user-defined match condition function object, when applied to the
|
||||
data contained in the dynamic buffer sequence, indicates a successful match.
|
||||
The call will block until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem">
|
||||
The match condition function object returns a std::pair where the second
|
||||
element evaluates to true.
|
||||
</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
|
||||
read_some function. If the match condition function object already indicates
|
||||
a match, the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload8.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload8.parameters"></a></span><a class="link" href="overload8.html#asio.reference.read_until.overload8.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">buffers</span></dt>
|
||||
<dd><p>
|
||||
A dynamic buffer sequence into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">match_condition</span></dt>
|
||||
<dd>
|
||||
<p>
|
||||
The function object to be called to determine whether a match exists.
|
||||
The signature of the function object must be:
|
||||
</p>
|
||||
<pre class="programlisting">pair<iterator, bool> match_condition(iterator begin, iterator end);
|
||||
</pre>
|
||||
<p>
|
||||
where <code class="computeroutput">iterator</code> represents the type:
|
||||
</p>
|
||||
<pre class="programlisting">buffers_iterator<DynamicBuffer_v1::const_buffers_type>
|
||||
</pre>
|
||||
<p>
|
||||
The iterator parameters <code class="computeroutput">begin</code> and <code class="computeroutput">end</code> define
|
||||
the range of bytes to be scanned to determine whether there is a
|
||||
match. The <code class="computeroutput">first</code> member of the return value is an iterator
|
||||
marking one-past-the-end of the bytes that have been consumed by
|
||||
the match function. This iterator is used to calculate the <code class="computeroutput">begin</code>
|
||||
parameter for any subsequent invocation of the match condition. The
|
||||
<code class="computeroutput">second</code> member of the return value is true if a match
|
||||
has been found, false otherwise.
|
||||
</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="asio.reference.read_until.overload8.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload8.return_value"></a></span><a class="link" href="overload8.html#asio.reference.read_until.overload8.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the dynamic buffer sequence's get area that have
|
||||
been fully consumed by the match function. Returns 0 if an error occurred.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload8.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload8.remarks"></a></span><a class="link" href="overload8.html#asio.reference.read_until.overload8.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful read_until operation, the dynamic buffer sequence may
|
||||
contain additional data beyond that which matched the function object.
|
||||
An application will typically leave that data in the dynamic buffer sequence
|
||||
for a subsequent read_until operation to examine.
|
||||
</p>
|
||||
<p>
|
||||
The default implementation of the <code class="computeroutput">is_match_condition</code> type
|
||||
trait evaluates to true for function pointers and function objects with
|
||||
a <code class="computeroutput">result_type</code> typedef. It must be specialised for other user-defined
|
||||
function objects.
|
||||
</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-2020 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="overload7.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload9.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,155 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>read_until (9 of 24 overloads)</title>
|
||||
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||||
<link rel="home" href="../../../index.html" title="Asio">
|
||||
<link rel="up" href="../read_until.html" title="read_until">
|
||||
<link rel="prev" href="overload8.html" title="read_until (8 of 24 overloads)">
|
||||
<link rel="next" href="overload10.html" title="read_until (10 of 24 overloads)">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="overload8.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload10.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="asio.reference.read_until.overload9"></a><a class="link" href="overload9.html" title="read_until (9 of 24 overloads)">read_until (9
|
||||
of 24 overloads)</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
Read data into a streambuf until it contains a specified delimiter.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
||||
typename Allocator>
|
||||
std::size_t read_until(
|
||||
SyncReadStream & s,
|
||||
asio::basic_streambuf< Allocator > & b,
|
||||
char delim);
|
||||
</pre>
|
||||
<p>
|
||||
This function is used to read data into the specified streambuf until the
|
||||
streambuf's get area contains the specified delimiter. The call will block
|
||||
until one of the following conditions is true:
|
||||
</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" 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
|
||||
read_some function. If the streambuf's get area already contains the delimiter,
|
||||
the function returns immediately.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload9.h0"></a>
|
||||
<span><a name="asio.reference.read_until.overload9.parameters"></a></span><a class="link" href="overload9.html#asio.reference.read_until.overload9.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">s</span></dt>
|
||||
<dd><p>
|
||||
The stream from which the data is to be read. The type must support
|
||||
the SyncReadStream concept.
|
||||
</p></dd>
|
||||
<dt><span class="term">b</span></dt>
|
||||
<dd><p>
|
||||
A streambuf object into which the data will be read.
|
||||
</p></dd>
|
||||
<dt><span class="term">delim</span></dt>
|
||||
<dd><p>
|
||||
The delimiter character.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload9.h1"></a>
|
||||
<span><a name="asio.reference.read_until.overload9.return_value"></a></span><a class="link" href="overload9.html#asio.reference.read_until.overload9.return_value">Return
|
||||
Value</a>
|
||||
</h6>
|
||||
<p>
|
||||
The number of bytes in the streambuf's get area up to and including the
|
||||
delimiter.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload9.h2"></a>
|
||||
<span><a name="asio.reference.read_until.overload9.exceptions"></a></span><a class="link" href="overload9.html#asio.reference.read_until.overload9.exceptions">Exceptions</a>
|
||||
</h6>
|
||||
<div class="variablelist">
|
||||
<p class="title"><b></b></p>
|
||||
<dl>
|
||||
<dt><span class="term">asio::system_error</span></dt>
|
||||
<dd><p>
|
||||
Thrown on failure.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload9.h3"></a>
|
||||
<span><a name="asio.reference.read_until.overload9.remarks"></a></span><a class="link" href="overload9.html#asio.reference.read_until.overload9.remarks">Remarks</a>
|
||||
</h6>
|
||||
<p>
|
||||
After a successful 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 read_until operation to examine.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.read_until.overload9.h4"></a>
|
||||
<span><a name="asio.reference.read_until.overload9.example"></a></span><a class="link" href="overload9.html#asio.reference.read_until.overload9.example">Example</a>
|
||||
</h6>
|
||||
<p>
|
||||
To read data into a streambuf until a newline is encountered:
|
||||
</p>
|
||||
<pre class="programlisting">asio::streambuf b;
|
||||
asio::read_until(s, b, '\n');
|
||||
std::istream is(&b);
|
||||
std::string line;
|
||||
std::getline(is, line);
|
||||
</pre>
|
||||
<p>
|
||||
After the <code class="computeroutput">read_until</code> operation completes successfully, the
|
||||
buffer <code class="computeroutput">b</code> contains the delimiter:
|
||||
</p>
|
||||
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\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' }
|
||||
</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">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-2020 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="overload8.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload10.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in new issue
Block a user