diff options
Diffstat (limited to 'doc/html/boost_asio/reference/read_until/overload6.html')
| -rw-r--r-- | doc/html/boost_asio/reference/read_until/overload6.html | 61 |
1 files changed, 32 insertions, 29 deletions
diff --git a/doc/html/boost_asio/reference/read_until/overload6.html b/doc/html/boost_asio/reference/read_until/overload6.html index 0bb345bc23..c960b671bb 100644 --- a/doc/html/boost_asio/reference/read_until/overload6.html +++ b/doc/html/boost_asio/reference/read_until/overload6.html @@ -1,13 +1,13 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>read_until (6 of 8 overloads)</title> +<title>read_until (6 of 16 overloads)</title> <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> <link rel="up" href="../read_until.html" title="read_until"> -<link rel="prev" href="overload5.html" title="read_until (5 of 8 overloads)"> -<link rel="next" href="overload7.html" title="read_until (7 of 8 overloads)"> +<link rel="prev" href="overload5.html" title="read_until (5 of 16 overloads)"> +<link rel="next" href="overload7.html" title="read_until (7 of 16 overloads)"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -24,30 +24,32 @@ </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="boost_asio.reference.read_until.overload6"></a><a class="link" href="overload6.html" title="read_until (6 of 8 overloads)">read_until - (6 of 8 overloads)</a> +<a name="boost_asio.reference.read_until.overload6"></a><a class="link" href="overload6.html" title="read_until (6 of 16 overloads)">read_until + (6 of 16 overloads)</a> </h4></div></div></div> <p> - Read data into a streambuf until some part of the data it contains matches - a regular expression. + Read data into a dynamic buffer sequence until some part of the data it + contains matches a regular expression. </p> -<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> - <span class="keyword">typename</span> <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a><span class="special">,</span> - <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">></span> -<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">read_until</span><span class="special">(</span> - <span class="identifier">SyncReadStream</span> <span class="special">&</span> <span class="identifier">s</span><span class="special">,</span> - <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">basic_streambuf</span><span class="special"><</span> <span class="identifier">Allocator</span> <span class="special">></span> <span class="special">&</span> <span class="identifier">b</span><span class="special">,</span> - <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">regex</span> <span class="special">&</span> <span class="identifier">expr</span><span class="special">,</span> - <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> +<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.html" title="Dynamic buffer requirements">DynamicBuffer</a>> +std::size_t read_until( + SyncReadStream & s, + DynamicBuffer && buffers, + const boost::regex & expr, + boost::system::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: + 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" style="list-style-type: disc; "> <li class="listitem"> - A substring of the streambuf's get area matches the regular expression. + A substring of the dynamic buffer sequence's get area matches the regular + expression. </li> <li class="listitem"> An error occurred. @@ -55,8 +57,8 @@ </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. + 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="boost_asio.reference.read_until.overload6.h0"></a> @@ -70,9 +72,9 @@ 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> +<dt><span class="term">buffers</span></dt> <dd><p> - A streambuf object into which the data will be read. + A dynamic buffer sequence into which the data will be read. </p></dd> <dt><span class="term">expr</span></dt> <dd><p> @@ -90,18 +92,19 @@ 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. + 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="boost_asio.reference.read_until.overload6.h2"></a> <span class="phrase"><a name="boost_asio.reference.read_until.overload6.remarks"></a></span><a class="link" href="overload6.html#boost_asio.reference.read_until.overload6.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. + 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> |