1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>read_until (22 of 24 overloads)</title> 5<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../read_until.html" title="read_until"> 9<link rel="prev" href="overload21.html" title="read_until (21 of 24 overloads)"> 10<link rel="next" href="overload23.html" title="read_until (23 of 24 overloads)"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="overload21.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload23.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h4 class="title"> 27<a name="boost_asio.reference.read_until.overload22"></a><a class="link" href="overload22.html" title="read_until (22 of 24 overloads)">read_until 28 (22 of 24 overloads)</a> 29</h4></div></div></div> 30<p> 31 Read data into a dynamic buffer sequence until some part of the data it 32 contains matches a regular expression. 33 </p> 34<pre class="programlisting">template< 35 typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>, 36 typename <a class="link" href="../DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>> 37std::size_t read_until( 38 SyncReadStream & s, 39 DynamicBuffer_v2 buffers, 40 const boost::regex & expr, 41 boost::system::error_code & ec, 42 typename enable_if< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type * = 0); 43</pre> 44<p> 45 This function is used to read data into the specified dynamic buffer sequence 46 until the dynamic buffer sequence's get area contains some data that matches 47 a regular expression. The call will block until one of the following conditions 48 is true: 49 </p> 50<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 51<li class="listitem"> 52 A substring of the dynamic buffer sequence's get area matches the regular 53 expression. 54 </li> 55<li class="listitem"> 56 An error occurred. 57 </li> 58</ul></div> 59<p> 60 This operation is implemented in terms of zero or more calls to the stream's 61 read_some function. If the dynamic buffer sequence's get area already contains 62 data that matches the regular expression, the function returns immediately. 63 </p> 64<h6> 65<a name="boost_asio.reference.read_until.overload22.h0"></a> 66 <span class="phrase"><a name="boost_asio.reference.read_until.overload22.parameters"></a></span><a class="link" href="overload22.html#boost_asio.reference.read_until.overload22.parameters">Parameters</a> 67 </h6> 68<div class="variablelist"> 69<p class="title"><b></b></p> 70<dl class="variablelist"> 71<dt><span class="term">s</span></dt> 72<dd><p> 73 The stream from which the data is to be read. The type must support 74 the SyncReadStream concept. 75 </p></dd> 76<dt><span class="term">buffers</span></dt> 77<dd><p> 78 A dynamic buffer sequence into which the data will be read. 79 </p></dd> 80<dt><span class="term">expr</span></dt> 81<dd><p> 82 The regular expression. 83 </p></dd> 84<dt><span class="term">ec</span></dt> 85<dd><p> 86 Set to indicate what error occurred, if any. 87 </p></dd> 88</dl> 89</div> 90<h6> 91<a name="boost_asio.reference.read_until.overload22.h1"></a> 92 <span class="phrase"><a name="boost_asio.reference.read_until.overload22.return_value"></a></span><a class="link" href="overload22.html#boost_asio.reference.read_until.overload22.return_value">Return 93 Value</a> 94 </h6> 95<p> 96 The number of bytes in the dynamic buffer sequence's get area up to and 97 including the substring that matches the regular expression. Returns 0 98 if an error occurred. 99 </p> 100<h6> 101<a name="boost_asio.reference.read_until.overload22.h2"></a> 102 <span class="phrase"><a name="boost_asio.reference.read_until.overload22.remarks"></a></span><a class="link" href="overload22.html#boost_asio.reference.read_until.overload22.remarks">Remarks</a> 103 </h6> 104<p> 105 After a successful read_until operation, the dynamic buffer sequence may 106 contain additional data beyond that which matched the regular expression. 107 An application will typically leave that data in the dynamic buffer sequence 108 for a subsequent read_until operation to examine. 109 </p> 110</div> 111<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 112<td align="left"></td> 113<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 114 Kohlhoff<p> 115 Distributed under the Boost Software License, Version 1.0. (See accompanying 116 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>) 117 </p> 118</div></td> 119</tr></table> 120<hr> 121<div class="spirit-nav"> 122<a accesskey="p" href="overload21.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload23.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 123</div> 124</body> 125</html> 126
